Skip to content

Improve README #340

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

Merged
merged 3 commits into from
Nov 30, 2024
Merged

Improve README #340

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b9a7b7a
README.md: separate PIP and Conda installations
mrmurilo75 Nov 27, 2024
2f0df61
README.md: fix typo
mrmurilo75 Nov 27, 2024
743ddc2
Merge branch 'master' into patch-1
chrisjsewell Nov 30, 2024
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
17 changes: 12 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,21 +33,28 @@ for even more speed!

## Installation

### PIP

```bash
conda install -c conda-forge markdown-it-py
pip install markdown-it-py[plugins]
```

or
or with extras

```bash
pip install markdown-it-py[plugins]
pip install markdown-it-py[linkify,plugins]
```

### Conda

```bash
conda install -c conda-forge markdown-it-py
```

or with extras

```bash
conda install -c conda-forge markdown-it-py linkify-it-py mdit-py-plugins
pip install markdown-it-py[linkify,plugins]
```

## Usage
Expand All @@ -63,7 +70,7 @@ from mdit_py_plugins.front_matter import front_matter_plugin
from mdit_py_plugins.footnote import footnote_plugin

md = (
MarkdownIt('commonmark' ,{'breaks':True,'html':True})
MarkdownIt('commonmark', {'breaks':True,'html':True})
.use(front_matter_plugin)
.use(footnote_plugin)
.enable('table')
Expand Down
Loading