From 12e8343068b906f8b2afddc5569968a8a91fa5b0 Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Mon, 29 Apr 2024 06:24:24 +0200 Subject: Adding upstream version 2.1.0. Signed-off-by: Daniel Baumann --- docs/plugins.md | 50 ++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 50 insertions(+) create mode 100644 docs/plugins.md (limited to 'docs/plugins.md') diff --git a/docs/plugins.md b/docs/plugins.md new file mode 100644 index 0000000..51a2fa6 --- /dev/null +++ b/docs/plugins.md @@ -0,0 +1,50 @@ +(md/plugins)= + +# Plugin extensions + +The following plugins are embedded within the core package: + +- [tables](https://help.github.com/articles/organizing-information-with-tables/) (GFM) +- [strikethrough](https://help.github.com/articles/basic-writing-and-formatting-syntax/#styling-text) (GFM) + +These can be enabled individually: + +```python +from markdown_it import MarkdownIt +md = MarkdownIt("commonmark").enable('table') +``` + +or as part of a configuration: + +```python +from markdown_it import MarkdownIt +md = MarkdownIt("gfm-like") +``` + +```{seealso} +See [](using.md) +``` + +Many other plugins are then available *via* the `mdit-py-plugins` package, including: + +- Front-matter +- Footnotes +- Definition lists +- Task lists +- Heading anchors +- LaTeX math +- Containers +- Word count + +For full information see: + +Or you can write them yourself! + +They can be chained and loaded *via*: + +```python +from markdown_it import MarkdownIt +from mdit_py_plugins import plugin1, plugin2 +md = MarkdownIt().use(plugin1, keyword=value).use(plugin2, keyword=value) +html_string = md.render("some *Markdown*") +``` -- cgit v1.2.3