Skip to content

Commit 5c80a37

Browse files
committed
Update README for uv usage
1 parent 766a72a commit 5c80a37

1 file changed

Lines changed: 11 additions & 8 deletions

File tree

README.md

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,24 +4,24 @@ A table of contents (TOC) plugin for [markdown-it-py](https://markdown-it-py.rea
44
based on [markdown-it-toc-done-right](https://github.com/nagaozen/markdown-it-toc-done-right).
55

66
- [Installation](#installation)
7-
- [Install using poetry](#install-using-poetry)
7+
- [Install using poetry or uv](#install-using-poetry-or-uv)
88
- [Install using pip](#install-using-pip)
99
- [Options](#options)
1010
- [Usage](#usage)
1111

1212
## Installation
1313

14-
### Install using poetry
14+
### Install using poetry or uv
1515

1616
Because **mdit-py-toc** is a plugin, you most likely need a tool to
1717
handle Python package dependencies and Python environments. Therefore we
18-
strongly recommend using [poetry].
18+
recommend using [poetry] or [uv].
1919

2020
You can install the latest stable release and add it as a dependency for your
21-
current project using [poetry]
21+
current project using [uv]
2222

23-
```
24-
poetry add mdit-py-toc
23+
```sh
24+
uv add mdit-py-toc
2525
```
2626

2727
### Install using pip
@@ -33,7 +33,7 @@ poetry add mdit-py-toc
3333
You can install the latest stable release from the Python Package Index (pypi)
3434
using [pip]
3535

36-
```
36+
```sh
3737
python -m pip install mdit-py-toc
3838
```
3939

@@ -71,8 +71,10 @@ markdown = """
7171
"""
7272
html = md.render(markdown)
7373
```
74+
7475
Creates the following HTML output
75-
```
76+
77+
```html
7678
<h1 id="a-page">A Page <a class="header-anchor" href="#a-page">¶</a></h1>
7779
<nav>
7880
<ol>
@@ -87,3 +89,4 @@ Creates the following HTML output
8789

8890
[poetry]: https://python-poetry.org/
8991
[pip]: https://pip.pypa.io/
92+
[uv]: https://docs.astral.sh/uv/

0 commit comments

Comments
 (0)