Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: add plugins mdformat-pyproject and mdformat-simple-breaks #418

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: add plugins mdformat-pyproject and mdformat-simple-breaks #418

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
25 changes: 23 additions & 2 deletions docs/users/plugins.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Plugins

Mdformat offers an extensible plugin system for both code fence content formatting and Markdown parser extensions (like GFM tables).
This document explains how to use plugins.
Mdformat offers an extensible plugin system for code fence content formatting, Markdown parser extensions (like GFM tables),
and modifying/adding other functionality. This document explains how to use plugins.
If you want to create a new plugin, refer to the [contributing](../contributors/contributing.md) docs.

## Code formatter plugins
Expand Down Expand Up @@ -139,3 +139,24 @@ formatted = mdformat.text(unformatted, extensions={"tables"})
<td>Adds the capability to auto-generate a table of contents</td>
</tr>
</table>

## Other misc plugins

Other plugins that don't fit the above categories.

### Existing plugins

<table>
<tr>
<th>Plugin</th>
<th>Description</th>
</tr>
<tr>
<td><a href="https://github.com/csala/mdformat-pyproject">mdformat-pyproject</a></td>
<td>Adds support for loading options from a <code>[tool.mdformat]</code> section inside the <code>pyproject.toml</code> file, if it exists</td>
</tr>
<tr>
<td><a href="https://github.com/csala/mdformat-simple-breaks">mdformat-simple-breaks</a></td>
<td>Render <a href="https://mdformat.readthedocs.io/en/stable/users/style.html#thematic-breaks">thematic breaks</a> using three dashes instead of 70 underscores</td>
</tr>
</table>