semvec/pypi-packages huggingface dataset:
mdit-py-toc 1.0.0
A table of contents (TOC) plugin for markdown-it-py
License: MIT
Requires Python: >=3.9,<4.0

# mdit-py-toc <!-- omit in toc -->

A table of contents (TOC) plugin for [markdown-it-py](https://markdown-it-py.readthedocs.io/en/latest/)
based on [markdown-it-toc-done-right](https://github.com/nagaozen/markdown-it-toc-done-right).

- [Installation](#installation)
  - [Install using poetry](#install-using-poetry)
  - [Install using pip](#install-using-pip)
- [Options](#options)
- [Usage](#usage)

## Installation

### Install using poetry

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

You can install the latest stable release and add it as a dependency for your
current project using [poetry]

```
poetry add mdit-py-toc
```

### Install using pip

> [!NOTE]
> The `pip install` command does no longer work out-of-the-box in newer
> distributions like Ubuntu >= 23.04 because of [PEP 668](https://peps.python.org/pep-0668).

You can install the latest stable release from the Python Package Index (pypi)
using [pip]

```
python -m pip install mdit-py-toc
```

## Options

| Name      | Description                                                            | Default               |
| --------- | ---------------------------------------------------------------------- | --------------------- |
| pattern   | The pattern serving as the TOC placeholder in your markdown            | `r"^(\[TOC\]")`       |
| level     | Heading level to apply anchors on or iterable of selected levels       | `(1, 2)`              |
| list_type | Type of list (`"ul"` for unordered, `"ol"` for ordered)                | `"ul"`                |
| slug_func | Function to convert heading title text to id slugs for link references | `mdit_py_toc.slugify` |

## Usage

`mdit-py-toc` works best in conjunction with the [anchors plugin](https://mdit-py-plugins.readthedocs.io/en/latest/#heading-anchors).

```python
from markdown_it import MarkdownIt
from mdit_py_plugins.anchors import anchors_plugin
from mdit_py_toc import toc_plugin, slugify

md = (
  MarkdownIt()
  .use(anchors_plugin, permalink=True, slug_func=slugify)
  .use(toc_plugin, list_type="ol")
)
markdown = """
# A Page

[TOC]

## Section 1

## Section 2
"""
html = md.render(markdown)
```
Creates the following HTML output
```
<h1 id="a-page">A Page <a class="header-anchor" href="#a-page">¶</a></h1>
<nav>
<ol>
<li><a href="#a-page">A Page </a><ol>
<li><a href="#section-1">Section 1 </a></li>
<li><a href="#section-2">Section 2 </a></li>
</ol></li>
</ol></nav>
<h2 id="section-1">Section 1 <a class="header-anchor" href="#section-1">¶</a></h2>
<h2 id="section-2">Section 2 <a class="header-anchor" href="#section-2">¶</a></h2>
```

[poetry]: https://python-poetry.org/
[pip]: https://pip.pypa.io/