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. See additional information on mdformat
plugins 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
# Or
# - "mdformat-mkdocs[recommended]"
pipx
pipx install mdformat
pipx inject mdformat mdformat-mkdocs
# Or
# pipx inject mdformat "mdformat-mkdocs[recommended]"
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
Configuration
mdformat-mkdocs
adds the CLI argument --align-semantic-breaks-in-numbered-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-numbered-lists
1. Semantic line feed where the following line is
three spaces deep
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.0.2rc2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 738f74e96446b4a7b0353ab1ca7fb3cfeb77c0f1bbec088b634d4cb00eb1988d |
|
MD5 | e02f8ff0dc3c7533aa4ed8819102c767 |
|
BLAKE2b-256 | 1c1a403da1b59c3341859c0d70b9e4219b2506c5ed4da504ce5f3c56bae30ef0 |