From 9e8c139ecd884d15a58a6b557cebd481e55f8f75 Mon Sep 17 00:00:00 2001 From: Jonathan Hult Date: Mon, 14 Oct 2024 03:23:29 -0500 Subject: [PATCH] docs: add plugins mdformat-pyproject and mdformat-simple-breaks (#418) Fixes #379 and #376. --- docs/users/plugins.md | 25 +++++++++++++++++++++++-- 1 file changed, 23 insertions(+), 2 deletions(-) diff --git a/docs/users/plugins.md b/docs/users/plugins.md index 0eced7d..6f162c8 100644 --- a/docs/users/plugins.md +++ b/docs/users/plugins.md @@ -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 @@ -149,3 +149,24 @@ formatted = mdformat.text(unformatted, extensions={"tables"}) Adds the capability to auto-generate a table of contents + +## Other misc plugins + +Other plugins that don't fit the above categories. + +### Existing plugins + + + + + + + + + + + + + + +
PluginDescription
mdformat-pyprojectAdds support for loading options from a [tool.mdformat] section inside the pyproject.toml file, if it exists
mdformat-simple-breaksRender thematic breaks using three dashes instead of 70 underscores