-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.en.md
62 lines (50 loc) · 2.89 KB
/
index.en.md
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
<!-- ====================== TOC ====================== -->
<!-- Generated by mkdocs-toc-md plugin -->
<!-- ================================================= -->
# Contents
**Using [custom template](https://github.com/try0/mkdocs-toc-md/blob/main/sample/custom_template/toc.md.j2)!**
Usage mkdocs-toc-md
## [mkdocs-toc-md](mkdocs-toc-md.en.md#mkdocs-toc-md)
Describes how to use mkdocs-toc-md plugin.
### [Sample](mkdocs-toc-md.en.md#sample)
### [Usage](mkdocs-toc-md.en.md#usage)
* [Generates toc markdown file.](mkdocs-toc-md.en.md#generates-toc-markdown-file)
* [Adds description.](mkdocs-toc-md.en.md#adds-description)
### [Options](mkdocs-toc-md.en.md#options)
* [toc_page_title: str](mkdocs-toc-md.en.md#toc_page_title-str)
* [toc_page_description: str](mkdocs-toc-md.en.md#toc_page_description-str)
* [header_level: int](mkdocs-toc-md.en.md#header_level-int)
* [pickup_description_meta: bool](mkdocs-toc-md.en.md#pickup_description_meta-bool)
* [pickup_description_class: bool](mkdocs-toc-md.en.md#pickup_description_class-bool)
* [output_path: str](mkdocs-toc-md.en.md#output_path-str)
* [output_log: bool](mkdocs-toc-md.en.md#output_log-bool)
* [ignore_page_pattern: str](mkdocs-toc-md.en.md#ignore_page_pattern-str)
* [remove_navigation_page_pattern: str](mkdocs-toc-md.en.md#remove_navigation_page_pattern-str)
* [template_dir_path: str](mkdocs-toc-md.en.md#template_dir_path-str)
* [beautiful_soup_parser: str](mkdocs-toc-md.en.md#beautiful_soup_parser-str)
* [integrate_mkdocs_static_i18n: bool](mkdocs-toc-md.en.md#integrate_mkdocs_static_i18n-bool)
* [languages: dict](mkdocs-toc-md.en.md#languages-dict)
* [shift_header: str (after_index, after_h1_of_index, none)](mkdocs-toc-md.en.md#shift_header-str-after_index-after_h1_of_index-none)
* [extend_module: bool](mkdocs-toc-md.en.md#extend_module-bool)
* [output_comment: str (html, metadata, none)](mkdocs-toc-md.en.md#output_comment-str-html-metadata-none)
## [nestmd](nestfolder/nest.md#nestmd)
### [Level2 header1](nestfolder/nest.md#level2-header1)
* [level3 header1](nestfolder/nest.md#level3-header1)
* [level3 header2](nestfolder/nest.md#level3-header2)
* [level3 header3](nestfolder/nest.md#level3-header3)
### [Level2 header2](nestfolder/nest.md#level2-header2)
* [level3 header1](nestfolder/nest.md#level3-header1_1)
* [level3 header2](nestfolder/nest.md#level3-header2_1)
* [level3 header3](nestfolder/nest.md#level3-header3_1)
## [shift/index.en.md](shift/index.en.md#shiftindexenmd)
Shift after h1 in the index file.
* [index](shift/index.en.md#index)
### [shift/shift.en.md](shift/shift.en.md#shiftshiftenmd)
* [Level2](shift/shift.en.md#level2)
### [shift/sub/index.en.md](shift/shiftsub/index.en.md#shiftsubindexenmd)
shift/sub
* [index](shift/shiftsub/index.en.md#index)
* [shift/shiftsub/shiftsub.en.md](shift/shiftsub/shiftsub.en.md#shiftshiftsubshiftsubenmd)
* [Level2](shift/shiftsub/shiftsub.en.md#level2)
---
[GitHub](https://github.com/try0/mkdocs-toc-md)