Skip to content

Commit

Permalink
docs: add mdformat-mkdocs (#380)
Browse files Browse the repository at this point in the history
* docs: add mdformat-mkdocs

* refactor: sort the plugins by plugin name

* docs: better summarize the mkdocs plugin
  • Loading branch information
KyleKing authored Jan 24, 2023
1 parent 5d9b573 commit 0cbd205
Showing 1 changed file with 25 additions and 20 deletions.
45 changes: 25 additions & 20 deletions docs/users/plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,11 +93,36 @@ formatted = mdformat.text(unformatted, extensions={"tables"})
<th>Syntax Extensions</th>
<th>Description</th>
</tr>
<tr>
<td><a href="https://github.com/KyleKing/mdformat-admon">mdformat-admon</a></td>
<td><code>admonition</code></td>
<td>Adds support for <a href="https://python-markdown.github.io/extensions/admonition/">python-markdown</a> admonitions</td>
</tr>
<tr>
<td><a href="https://github.com/executablebooks/mdformat-deflist">mdformat-deflist</a></td>
<td><code>deflist</code></td>
<td>Adds support for <a href="https://pandoc.org/MANUAL.html#definition-lists">Pandoc-style</a> definition lists</td>
</tr>
<tr>
<td><a href="https://github.com/executablebooks/mdformat-footnote">mdformat-footnote</a></td>
<td><code>footnote</code></td>
<td>Adds support for <a href="https://pandoc.org/MANUAL.html#footnotes">Pandoc-style</a> footnotes</td>
</tr>
<tr>
<td><a href="https://github.com/butler54/mdformat-frontmatter">mdformat-frontmatter</a></td>
<td><code>frontmatter</code></td>
<td>Adds support for front matter, and formats YAML front matter</td>
</tr>
<tr>
<td><a href="https://github.com/hukkin/mdformat-gfm">mdformat-gfm</a></td>
<td><code>gfm</code></td>
<td>Changes target specification to GitHub Flavored Markdown (GFM)</td>
</tr>
<tr>
<td><a href="https://github.com/KyleKing/mdformat-mkdocs">mdformat-mkdocs</a></td>
<td><code>mkdocs</code></td>
<td>Changes target specification to MKDocs. Indents lists with 4-spaces instead of 2</td>
</tr>
<tr>
<td><a href="https://github.com/executablebooks/mdformat-myst">mdformat-myst</a></td>
<td><code>myst</code></td>
Expand All @@ -113,24 +138,4 @@ formatted = mdformat.text(unformatted, extensions={"tables"})
<td><code>toc</code></td>
<td>Adds the capability to auto-generate a table of contents</td>
</tr>
<tr>
<td><a href="https://github.com/executablebooks/mdformat-footnote">mdformat-footnote</a></td>
<td><code>footnote</code></td>
<td>Adds support for <a href="https://pandoc.org/MANUAL.html#footnotes">Pandoc-style</a> footnotes</td>
</tr>
<tr>
<td><a href="https://github.com/butler54/mdformat-frontmatter">mdformat-frontmatter</a></td>
<td><code>frontmatter</code></td>
<td>Adds support for front matter, and formats YAML front matter</td>
</tr>
<tr>
<td><a href="https://github.com/executablebooks/mdformat-deflist">mdformat-deflist</a></td>
<td><code>deflist</code></td>
<td>Adds support for <a href="https://pandoc.org/MANUAL.html#definition-lists">Pandoc-style</a> definition lists</td>
</tr>
<tr>
<td><a href="https://github.com/KyleKing/mdformat-admon">mdformat-admon</a></td>
<td><code>admonition</code></td>
<td>Adds support for <a href="https://python-markdown.github.io/extensions/admonition/">python-markdown</a> admonitions</td>
</tr>
</table>

0 comments on commit 0cbd205

Please sign in to comment.