Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: steer users to pipx #453

Merged
merged 1 commit into from
Oct 15, 2024
Merged

docs: steer users to pipx #453

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions README.md
View file
Open in desktop
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
Loading