Merge pull request #15 from DARPA-ASKEM/14-task-update-mkdocs-mkdocs-…

…material-versions-and-add-print-site-plugin

#14 Update mkdocs versions, add print site plugin

.gitignore

@@ -32,3 +32,5 @@ bin/
 overrides/.icons/
 _notes.md
 site/
+vale.ini
+styles/

README.md

@@ -12,6 +12,7 @@ The help is designed to build with the latest MkDocs and Material theme. It also
 
 - [mkdocs-glightbox](https://github.com/blueswen/mkdocs-glightbox) enables zoom functionality for images.
 - [mkdocs-macros-plugin](https://github.com/fralau/mkdocs_macros_plugin) allows the use of variables in Markdown files.
+- [mkdocs-print-site-plugin](https://github.com/timvink/mkdocs-print-site-plugin) creates a single page with all site content so that it can be exported to PDF.
 
 To install the latest MkDocs, theme, and extensions: 
 
@@ -20,6 +21,7 @@ pip install mkdocs
 pip install mkdocs-material
 pip install mkdocs-glightbox
 pip install mkdocs-macros-plugin
+pip install mkdocs-print-site-plugin
 ``` 
 
 ## Building the help site ##

docs/assets/custom_banner.tpl

@@ -0,0 +1,4 @@
+<p>
+ <em>This box will disappear when printing</em>
+</p>
+<p>This page combines all help site pages into one. Export to PDF using <b>File > Print > Save as PDF</b>.</p>

mkdocs.yml

@@ -1,7 +1,7 @@
 site_name: Terarium Help
 site_author: Uncharted Software Inc.
 
-copyright: Copyright © 2023 Uncharted Software Inc.
+copyright: Copyright © 2024 Uncharted Software Inc.
 
 theme:
  name: material
@@ -35,9 +35,15 @@ theme:
  language: custom
 
 plugins:
- search: {}
- glightbox: {}
- macros: {}
+ - search: {}
+ - glightbox: {}
+ - macros: {}
+ - print-site:
+ enumerate_headings: false
+ add_cover_page: true
+ add_to_navigation: true
+ add_print_site_banner: true
+ print_site_banner_template: "docs/assets/custom_banner.tpl"
 
 extra:
  social:
@@ -58,11 +64,12 @@ markdown_extensions:
  alternate_style: true 
  pymdownx.keys: {}
  pymdownx.emoji:
- emoji_index: !!python/name:materialx.emoji.twemoji
- emoji_generator: !!python/name:materialx.emoji.to_svg
+ emoji_index: !!python/name:material.extensions.emoji.twemoji
+ emoji_generator: !!python/name:material.extensions.emoji.to_svg
  options:
  custom_icons:
  - overrides/.icons
+ tables:
 
 extra_css:
  - stylesheets/extra.css

requirements.txt

@@ -1,5 +1,6 @@
 # Requirements for mkdocs
-mkdocs == 1.5.2
-mkdocs-material == 9.2.7
-mkdocs-glightbox == 0.3.4
-mkdocs-macros-plugin == 0.7.0
+mkdocs == 1.5.3
+mkdocs-material == 9.5.13
+mkdocs-glightbox == 0.3.7
+mkdocs-macros-plugin == 1.0.5
+mkdocs-print-site-plugin == 2.3.6