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
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
mdformat_mkdocs-1.0.1.tar.gz
(6.6 kB
view hashes)
Built Distribution
Close
Hashes for mdformat_mkdocs-1.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1a4940bac3bf52689da62da4cf2a24e25cc6fd30f70fe4792d87b9fd47eb0940 |
|
MD5 | bae73c70dfb1d67031eb723340f370a8 |
|
BLAKE2b-256 | 5829e2342969d10e9430a26848efb68377d827f40dd1e3d5c2d3aa7a26d040ad |