An mdformat plugin for mkdocs.
Project description
mdformat-mkdocs
An mdformat plugin for mkdocs.
Warning
This is an initial proof of concept. Non-list items nested within a list are not properly handled (i.e. nested code blocks, quotes, etc.). Please open an issue and share examples that aren't properly supported!
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
Pre-commit
repos:
- repo: https://github.com/executablebooks/mdformat
rev: 0.7.16
hooks:
- id: mdformat
additional_dependencies:
- mdformat-mkdocs
pipx
pipx install mdformat
pipx inject mdformat mdformat-mkdocs
Caveats
- All indents are converted to 4-spaces
- This plugin converts all bulleted items to dashes and numerals to
1.
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-0.0.1.tar.gz
(6.0 kB
view hashes)
Built Distribution
Close
Hashes for mdformat_mkdocs-0.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c5785f6a4d3913a433afce7c4ae7e8f52577af1c36c98c9e8bad25ab4f803bfa |
|
MD5 | 68c7ce3a8eae6e6f0b653bc8dce8af81 |
|
BLAKE2b-256 | 14571c47aa4696177de6e4c4ff9fdc62331a128d6b8ae54f13bfa1f6a0f84d69 |