New default: print site banner is not displayed by default

timvink · Sep 13, 2021 · 5f121e9 · 5f121e9
1 parent 50011c7
commit 5f121e9
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 4 deletions.
diff --git a/docs/options.md b/docs/options.md
@@ -5,8 +5,9 @@ You can customize `mkdocs-print-site-plugin` in your `mkdocs.yml` with the follo
 ```yaml
 plugins:
   - print-site:
-      add_to_navigation: true
+      add_to_navigation: false
       print_page_title: 'Print Site'
+      add_print_site_banner: false
       # Table of contents
       add_table_of_contents: true
       toc_title: 'Table of Contents'
@@ -23,7 +24,7 @@ plugins:
 ```
 
 `add_to_navigation`
-:   Default is `true`. Adds a link 'Print Site' to your site navigation. You can also set to `false` and explicitly include the link in your navigation (`/print_page` or `/print_page.html`).
+:   Default is `false`. Adds a link 'Print Site' to your site navigation. You can also set to `false` and explicitly include the link in your navigation (`/print_page` or `/print_page.html`).
 
 `print_page_title`
 :   Default is `'Print Site'`. When `add_to_navigation` is set to `true` this setting controls the name of the print page in the navigation of the site. This setting is ignored when `add_to_navigation` is set to `false`.
@@ -57,7 +58,7 @@ plugins:
 :   Default `""`. The path to a custom cover page template to use. See [Customizing the Cover Page](customization/cover_page.md) for more info.
 
 `add_print_site_banner`
-:   Default `true`. When enabled, a banner is added to the top of the print page, explaining to users the current page contains all site pages.
+:   Default `false`. When enabled, a banner is added to the top of the HTML print page, explaining to users the current page contains all site pages.
 
 `print_site_banner_template`
 :   Default `""`. The path to a custom print site banner template to use. See [Customizing the print site banner](customization/banner.md) for more info.

diff --git a/mkdocs_print_site_plugin/plugin.py b/mkdocs_print_site_plugin/plugin.py
@@ -33,7 +33,7 @@ class PrintSitePlugin(BasePlugin):
         ("enumerate_figures", config_options.Type(bool, default=False)),
         ("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=True)),
+        ("add_print_site_banner", config_options.Type(bool, default=False)),
         ("print_site_banner_template", config_options.Type(str, default="")),
         ("path_to_pdf", config_options.Type(str, default="")),
         ("enabled", config_options.Type(bool, default=True)),