Skip to content

Commit

Permalink
New default: toc_depth is now set to 3 instead of 6
Browse files Browse the repository at this point in the history
  • Loading branch information
timvink committed Sep 13, 2021
1 parent 4e3a235 commit eb2fdc2
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 2 deletions.
2 changes: 1 addition & 1 deletion docs/options.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ plugins:
: Default is `'Table of Contents'`. When `add_table_of_contents` is set to `true` this setting controls the name of the table of contents. This setting is ignored when `add_table_of_contents` is set to `false`.

`toc_depth`
: Default is `6`. When `add_table_of_contents` is set to `true` this setting controls the depth of the table of contents. This setting is ignored when `add_table_of_contents` is set to `false`.
: Default is `3`. When `add_table_of_contents` is set to `true` this setting controls the depth of the table of contents. This setting is ignored when `add_table_of_contents` is set to `false`.

`add_full_urls`
: Default is `false`. When printing a page, you cannot see the target of a link. This option adds the target url in parenthesis behind a link.
Expand Down
2 changes: 1 addition & 1 deletion mkdocs_print_site_plugin/plugin.py
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ class PrintSitePlugin(BasePlugin):
("print_page_title", config_options.Type(str, default="Print Site")),
("add_table_of_contents", config_options.Type(bool, default=True)),
("toc_title", config_options.Type(str, default="Table of Contents")),
("toc_depth", config_options.Type(int, default=6)),
("toc_depth", config_options.Type(int, default=3)),
("add_full_urls", config_options.Type(bool, default=False)),
("enumerate_headings", config_options.Type(bool, default=False)),
("enumerate_figures", config_options.Type(bool, default=False)),
Expand Down

0 comments on commit eb2fdc2

Please sign in to comment.