Skip to content

Commit 302e6dd

Browse files
committed
docs: steer users to pipx
1 parent 2e31be5 commit 302e6dd

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

README.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,26 +28,29 @@ Find out more in the [docs](https://mdformat.readthedocs.io).
2828
Install with [CommonMark](https://spec.commonmark.org/current/) support:
2929

3030
```bash
31-
pip install mdformat
31+
pipx install mdformat
3232
```
3333

3434
Install with [GitHub Flavored Markdown (GFM)](https://github.github.com/gfm/) support:
3535

3636
```bash
37-
pip install mdformat-gfm
37+
pipx install mdformat
38+
pipx inject mdformat mdformat-gfm
3839
```
3940

4041
Note that GitHub's Markdown renderer supports syntax extensions not included in the GFM specification.
4142
For full GitHub support do:
4243

4344
```bash
44-
pip install mdformat-gfm mdformat-frontmatter mdformat-footnote mdformat-gfm-alerts
45+
pipx install mdformat
46+
pipx inject mdformat mdformat-gfm mdformat-frontmatter mdformat-footnote mdformat-gfm-alerts
4547
```
4648

4749
Install with [Markedly Structured Text (MyST)](https://myst-parser.readthedocs.io/en/latest/using/syntax.html) support:
4850

4951
```bash
50-
pip install mdformat-myst
52+
pipx install mdformat
53+
pipx inject mdformat mdformat-myst
5154
```
5255

5356
<!-- end installing -->

0 commit comments

Comments
 (0)