Skip to content

Commit

Permalink
docs: steer users to pipx
Browse files Browse the repository at this point in the history
  • Loading branch information
hukkin committed Oct 15, 2024
1 parent 2e31be5 commit 302e6dd
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,26 +28,29 @@ Find out more in the [docs](https://mdformat.readthedocs.io).
Install with [CommonMark](https://spec.commonmark.org/current/) support:

```bash
pip install mdformat
pipx install mdformat
```

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

```bash
pip install mdformat-gfm
pipx install mdformat
pipx inject mdformat mdformat-gfm
```

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

```bash
pip install mdformat-gfm mdformat-frontmatter mdformat-footnote mdformat-gfm-alerts
pipx install mdformat
pipx inject mdformat mdformat-gfm mdformat-frontmatter mdformat-footnote mdformat-gfm-alerts
```

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

```bash
pip install mdformat-myst
pipx install mdformat
pipx inject mdformat mdformat-myst
```

<!-- end installing -->
Expand Down

0 comments on commit 302e6dd

Please sign in to comment.