Skip to content

Commit

Permalink
New defaults: enumerate_headings and enumerate_figures set to true
Browse files Browse the repository at this point in the history
  • Loading branch information
timvink committed Sep 14, 2021
1 parent c8fad64 commit 9f204b8
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions docs/options.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,12 +44,12 @@ plugins:
For example "[google.com](https://www.google.com)" will be replaced by "[google.com](https://www.google.com) (https://www.google.com)"

`enumerate_headings`
: Default `false`. This will add numbering (enumeration) to all headings as well as the table of contents. Note this will only enumerate the print site page; if you want to enumerate the entire site, you can use [mkdocs-enumerate-headings-plugin](https://github.com/timvink/mkdocs-enumerate-headings-plugin).
: Default `true`. This will add numbering (enumeration) to all headings as well as the table of contents. Note this will only enumerate the print site page; if you want to enumerate the entire site, you can use [mkdocs-enumerate-headings-plugin](https://github.com/timvink/mkdocs-enumerate-headings-plugin).

Example "1.2 A chapter subsection".

`enumerate_figures`
: Default `false`. This will add numbering to all figure captions (for example "Figure 1: <caption>"). Works especially well with [mkdocs-img2fig-plugin](https://github.com/stuebersystems/mkdocs-img2fig-plugin).
: Default `true`. This will add numbering to all figure captions (for example "Figure 1: <caption>"). Works especially well with [mkdocs-img2fig-plugin](https://github.com/stuebersystems/mkdocs-img2fig-plugin).

`add_cover_page`
: Default `false`. When enabled, a cover page is added to the print page, displaying the `site_title` and other information from the `mkdocs.yml` file. See also [Customizing the cover page](customization/cover_page.md)
Expand Down
4 changes: 2 additions & 2 deletions mkdocs_print_site_plugin/plugin.py
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,8 @@ class PrintSitePlugin(BasePlugin):
("toc_title", config_options.Type(str, default="Table of Contents")),
("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)),
("enumerate_headings", config_options.Type(bool, default=True)),
("enumerate_figures", config_options.Type(bool, default=True)),
("add_cover_page", config_options.Type(bool, default=False)),
("cover_page_template", config_options.Type(str, default="")),
("add_print_site_banner", config_options.Type(bool, default=False)),
Expand Down

0 comments on commit 9f204b8

Please sign in to comment.