Skip to content

Commit

Permalink
Improve README (#340)
Browse files Browse the repository at this point in the history
  • Loading branch information
mrmurilo75 authored Nov 30, 2024
1 parent a479316 commit bbbaba0
Showing 1 changed file with 12 additions and 5 deletions.
17 changes: 12 additions & 5 deletions README.md
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

0 comments on commit bbbaba0

Please sign in to comment.