Generate a toc markdown file
Project description
mkdocs-toc-md
mkdocs-toc-md generates a table of contents as markdown. To render as html, the toc md file must be generated before the mkdocs build
.
Sample
Usage
-
Add plugin conifg to mkdocs.yml.
plugins: - toc-md: toc_page_title: Contents toc_page_description: Usage mkdocs-toc-md header_level: 3 pickup_description_meta: true pickup_description_class: true output_path: index.md output_log: true ignore_page_pattern: index.md remove_navigation_page_pattern: index.md template_dir_path: custom_template
-
Run
mkdocs serve
to output toc md file.
Options
-
page_title: str
h1 text in toc md. -
page_description: str
Renders description after h1. -
header_level: int
Header level (depth) to render.
h1→1, h2→2, ... -
pickup_description_meta: bool
Renders description after h2 in toc md. -
pickup_description_class: bool
Renders description after h2 in toc md.# mkdocs-toc-md <div class="toc-md-description"> mkdocs-toc-md generates a table of contents page. </div>
-
output_path: str
Path to save rendered toc md file. -
output_log: bool
Output toc md contents to console. -
ignore_page_pattern: str
Regular expression pattern of md filenames to be excluded from toc md files.
To prevent the table of contents page from listing itself, set the same value as the output file name (output_path). -
remove_navigation_page_pattern: str
Regular expression pattern of md filenames to remove navigation items.
To hide the navigation on the table of contents page, set the same value as the output file name (output_path). -
template_dir_path: str
Path of template dir. Puttoc.md.j2
in your custom template dir.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for mkdocs_toc_md-0.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 52586f6f75923ef5c53f5a9792900d9a7d7f42560844500063fa98d60588f27c |
|
MD5 | 177f81daecea811e3efc707e5ec6a5d3 |
|
BLAKE2b-256 | f327d34264421ea83fdc71e53bc1f3bf728b1ca2b3b23f5352ac8acda3d3d287 |