<commit_before>![Doxter](doxter/resources/img/doxter.png)

# Doxter
Lovingly crafted by [<NAME>](https://selv.in) for [Craft CMS][craft]

**Doxter** is a markdown plugin designed to improve the way you write documentation

<a href='https://pledgie.com/campaigns/27296'>
<img alt='Support Craft Plugin Development By <NAME>' src='https://pledgie.com/campaigns/27296.png?skin_name=chrome' border='0'>
</a>

## Installation
1. Download the [latest release][release] or clone this repo
2. Extract the archive and place `doxter` inside your `craft/plugins` directory
4. Install **Doxter** from the Control Panel **@** `Settings > Plugins`
5. Adjust plugin settings from the Control Panel **@** `Settings > Plugins > Doxter`
6. FieldType settings can be adjusted when you create your **Doxter** field

## Features
* [Live Preview][preview] Support
* Fast and consistent [Github Flavored Markdown][gfm] Parsing
* **Linkable Headers** based on parsing settings
* Advanced [Reference Tags][refTags] parsing
* Minimalist editor with custom toolbar for [Reference Tags][refTags]
* Extensible **Shortcode** parsing support
* Event driven parsing API for developers
* Advanced fenced codeblock parsing
* Support for typography styles for better web typography
* Support for multiple fieldtypes in single [Entry Type][entrytypes] or  [Matrix Field][matrix]
* **Unit Tested** with care

---

## Doxter Field<commit_msg>Add link to Craft 3 version<commit_after>![Doxter](doxter/resources/img/doxter.png)

# Doxter
Lovingly crafted by [<NAME>](https://selv.in) for [Craft CMS][craft]

**Doxter** is a markdown plugin designed to improve the way you write documentation

For the Craft 3 version of this plugin, see [craft-plugin-doxter](https://github.com/selvinortiz/craft-plugin-doxter).

<a href='https://pledgie.com/campaigns/27296'>
<img alt='Support Craft Plugin Development By <NAME>' src='https://pledgie.com/campaigns/27296.png?skin_name=chrome' border='0'>
</a>

## Installation
1. Download the [latest release][release] or clone this repo
2. Extract the archive and place `doxter` inside your `craft/plugins` directory
4. Install **Doxter** from the Control Panel **@** `Settings > Plugins`
5. Adjust plugin settings from the Control Panel **@** `Settings > Plugins > Doxter`
6. FieldType settings can be adjusted when you create your **Doxter** field

## Features
* [Live Preview][preview] Support
* Fast and consistent [Github Flavored Markdown][gfm] Parsing
* **Linkable Headers** based on parsing settings
* Advanced [Reference Tags][refTags] parsing
* Minimalist editor with custom toolbar for [Reference Tags][refTags]
* Extensible **Shortcode** parsing support
* Event driven parsing API for developers
* Advanced fenced codeblock parsing
* Support for typography styles for better web typography
* Support for multiple fieldtypes in single [Entry Type][entrytypes] or  [Matrix Field][matrix]
* **Unit Tested** with care

---

## Doxter Field
{'fraction_non_alphanumeric': 0.11556764106050306, 'fraction_numerical': 0.011556764106050306, 'mean_word_length': 5.55456570155902, 'pattern_counts': {'":': 0, '<': 13, '<?xml version=': 0, '>': 19, 'https://': 7, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 4, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '432635', 'n_tokens_mistral': 894, 'n_tokens_neox': 849, 'n_words': 324}