Skip to content

Commit ed70db4

Browse files
committed
docs: cleanup supported summary
1 parent d7b73ea commit ed70db4

File tree

1 file changed

+3
-4
lines changed

1 file changed

+3
-4
lines changed

README.md

+3-4
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,11 @@ An [mdformat](https://github.com/executablebooks/mdformat) plugin for [mkdocs](h
1111

1212
Supports:
1313

14-
- Indents are converted to 4-spaces instead of 2
15-
- *Note*: see caveats when using the optional Semantic Indents on numbered lists which may not be a full multiple of 4
14+
- Indents are converted to four-spaces instead of two
15+
- *Note*: when specifying `--align-semantic-breaks-in-lists`, the nested indent for ordered lists is three, but is otherwise a multiple of four
1616
- Unordered list bullets are converted to dashes (`-`) instead of `*`
1717
- By default, ordered lists are standardized on a single digit (`1.` or `0.`) unless `--number` is specified, then `mdformat-mkdocs` will apply consecutive numbering to ordered lists [for consistency with `mdformat`](https://github.com/executablebooks/mdformat?tab=readme-ov-file#options)
18-
- standardized as all `1.` rather than incrementing
19-
- Admonitions (extends [`mdformat-admon`](https://pypi.org/project/mdformat-admon))
18+
- Supports MkDocs admonition syntax
2019
- MkDocs-Material Content Tabs (<https://squidfunk.github.io/mkdocs-material/reference/content-tabs>)
2120
- Note: the markup (HTML) rendered by this plugin is sufficient for formatting but not for viewing in a browser. Please open an issue if you have a need to generate valid HTML.
2221
- "[Markdown anchors](https://mkdocstrings.github.io/autorefs/#markdown-anchors)" syntax from the `mkdocs` [autorefs](https://mkdocstrings.github.io/autorefs) plugin

0 commit comments

Comments
 (0)