An mdformat plugin for mkdocs.
Project description
mdformat-mkdocs
An mdformat plugin for mkdocs.
Usage
Add this package wherever you use mdformat
and the plugin will be auto-recognized. No additional configuration necessary. For additional information on plugins, see the official mdformat
documentation here
Tip: this package specifies an "extra" ('recommended'
) for plugins that work well with mkdocs:
- mdformat-admon
- mdformat-beautysh
- mdformat-black
- mdformat-config
- mdformat-footnote
- mdformat-frontmatter
- mdformat-simple-breaks
- mdformat-tables
- mdformat-toc
- mdformat-web
Pre-commit
repos:
- repo: https://github.com/executablebooks/mdformat
rev: 0.7.16
hooks:
- id: mdformat
additional_dependencies:
- mdformat-mkdocs>=1.1.2
# Or
# - "mdformat-mkdocs[recommended]>=1.1.2"
pipx
pipx install mdformat
pipx inject mdformat mdformat-mkdocs
# Or
# pipx inject mdformat "mdformat-mkdocs[recommended]"
CLI Options
mdformat-mkdocs
adds the CLI argument --align-semantic-breaks-in-lists
to optionally align line breaks in numbered lists to 3-spaces. If not specified, the default of 4-indents is followed universally.
# with: mdformat
1. Semantic line feed where the following line is
three spaces deep
# vs. with: mdformat --align-semantic-breaks-in-lists
1. Semantic line feed where the following line is
three spaces deep
Note: the align-semantic-breaks-in-lists
setting is not supported in the configuration file yet (https://github.com/executablebooks/mdformat/issues/378)
Caveats
- All indents are converted to 4-spaces
- This plugin converts all bulleted items to dashes (
-
) and numerals to1.
See the example test files, ./tests/pre-commit-test.md and ./tests/fixtures.md
Contributing
See CONTRIBUTING.md
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for mdformat_mkdocs-1.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | e5e7b41f181753a18618e5a7eb397466f2aa94f0f7bb5e97c44a780cb24c59d9 |
|
MD5 | eba88dc7970d870de2e6158747f52297 |
|
BLAKE2b-256 | 23c0f1168f9c4950146fbe74b6c1cfc02abb5fc03fcf154a79972643bb8c0a91 |