|
2 | 2 |
|
3 | 3 | [![Build Status][ci-badge]][ci-link] [![PyPI version][pypi-badge]][pypi-link] |
4 | 4 |
|
5 | | -<!-- [![codecov.io][cov-badge]][cov-link] |
6 | | -[cov-badge]: https://codecov.io/gh/executablebooks/mdformat-mkdocs/branch/main/graph/badge.svg |
7 | | -[cov-link]: https://codecov.io/gh/executablebooks/mdformat-mkdocs |
8 | | - --> |
9 | | - |
10 | 5 | An [mdformat](https://github.com/executablebooks/mdformat) plugin for [mkdocs](https://github.com/mkdocs/mkdocs) and packages commonly used with MkDocs ([mkdocs-material](https://squidfunk.github.io/mkdocs-material), [mkdocstrings](https://mkdocstrings.github.io), and [python-markdown](https://python-markdown.github.io)) |
11 | 6 |
|
12 | 7 | Supports: |
@@ -41,16 +36,22 @@ See the example test files, [./tests/pre-commit-test.md](https://raw.githubuserc |
41 | 36 |
|
42 | 37 | 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](https://mdformat.readthedocs.io/en/stable/users/plugins.html) |
43 | 38 |
|
44 | | -**Tip**: this package specifies an "extra" (`'recommended'`) for plugins that work well with typical documentation managed by `mkdocs`: |
| 39 | +### Optional Extras |
| 40 | + |
| 41 | +This package specifies two optional "extra" plugins (`'recommended'` and `'recommended-mdsf'` ) for plugins that work well with typical documentation managed by `mkdocs`: |
45 | 42 |
|
46 | | -- [mdformat-beautysh](https://pypi.org/project/mdformat-beautysh) |
47 | | -- [mdformat-black](https://pypi.org/project/mdformat-black) |
48 | | -- [mdformat-config](https://pypi.org/project/mdformat-config) |
49 | | -- [mdformat-footnote](https://pypi.org/project/mdformat-footnote) |
50 | | -- [mdformat-front-matters](https://pypi.org/project/mdformat-front-matters) (previously [mdformat-frontmatter](https://pypi.org/project/mdformat-frontmatter)) |
51 | | -- [mdformat-simple-breaks](https://pypi.org/project/mdformat-simple-breaks) |
52 | | -- [mdformat-web](https://pypi.org/project/mdformat-web) |
53 | | -- [mdformat-wikilink](https://github.com/tmr232/mdformat-wikilink) |
| 43 | +- For `'recommended'`: |
| 44 | + - [mdformat-beautysh](https://pypi.org/project/mdformat-beautysh) |
| 45 | + - [mdformat-config](https://pypi.org/project/mdformat-config) |
| 46 | + - [mdformat-footnote](https://pypi.org/project/mdformat-footnote) |
| 47 | + - [mdformat-front-matters](https://pypi.org/project/mdformat-front-matters) (previously [mdformat-frontmatter](https://pypi.org/project/mdformat-frontmatter)) |
| 48 | + - [mdformat-gfm](https://github.com/hukkin/mdformat-gfm) |
| 49 | + - [mdformat-ruff](https://github.com/Freed-Wu/mdformat-ruff) |
| 50 | + - [mdformat-simple-breaks](https://pypi.org/project/mdformat-simple-breaks) |
| 51 | + - [mdformat-web](https://pypi.org/project/mdformat-web) |
| 52 | + - [mdformat-wikilink](https://github.com/tmr232/mdformat-wikilink) |
| 53 | +- For `'recommended-mdsf'`: |
| 54 | + - Instead of `mdformat-beautysh`, `mdformat-config`, `mdformat-ruff`, and `mdformat-web`, the "mdsf" extras install `mdformat-hooks`, which allows the use of `mdsf` for formatting code blocks in hundreds of languages using CLI formatters you already have installed; however, this requires extra configuration, so make sure to see the README: <https://github.com/KyleKing/mdformat-hooks> |
54 | 55 |
|
55 | 56 | ### pre-commit/prek |
56 | 57 |
|
|
63 | 64 | additional_dependencies: |
64 | 65 | - mdformat-mkdocs |
65 | 66 | # Or |
| 67 | + # - "mdformat-mkdocs[recommended-mdsf]>=5.1.0" |
| 68 | + # Or |
66 | 69 | # - "mdformat-mkdocs[recommended]" |
67 | 70 | ``` |
68 | 71 |
|
|
0 commit comments