Contents ¶
Using custom template !
Usage mkdocs-toc-md
mkdocs-toc-md ¶
Describes how to use mkdocs-toc-md plugin.
Sample ¶
Usage ¶
Options ¶
- toc_page_title: str
- toc_page_description: str
- header_level: int
- pickup_description_meta: bool
- pickup_description_class: bool
- output_path: str
- output_log: bool
- ignore_page_pattern: str
- remove_navigation_page_pattern: str
- template_dir_path: str
- beautiful_soup_parser: str
- integrate_mkdocs_static_i18n: bool
- languages: dict
- shift_header: str (after_index, after_h1_of_index, none)
- extend_module: bool
- output_comment: str (html, metadata, none)
nestmd ¶
Level2 header1 ¶
Level2 header2 ¶
shift/index.en.md ¶
Shift after h1 in the index file.