]> gitweb.fluxo.info Git - templates.git/commitdiff
MkDocs config improvements
authorSilvio Rhatto <rhatto@riseup.net>
Sat, 14 Sep 2024 13:42:26 +0000 (10:42 -0300)
committerSilvio Rhatto <rhatto@riseup.net>
Sat, 14 Sep 2024 13:42:26 +0000 (10:42 -0300)
mkdocs.yml
scripts/provision

index 7ae48fd760afef40ccf586b9d68279199f78b523..0f007867b24e3b7cb34b9eeaff924e20e1316291 100644 (file)
@@ -49,7 +49,8 @@ plugins:
 
   # Awesome Pages Plugin
   # https://github.com/lukasgeiter/mkdocs-awesome-pages-plugin
-  awesome-pages: {}
+  awesome-pages:
+    collapse_single_pages: true
 
   # The built-in privacy plugin automatically identifies external assets as
   # part of the build process and downloads all assets for very simple
@@ -81,6 +82,13 @@ plugins:
         nav_translations:
           Provedor: Provider
 
+  # Redirects
+  # https://github.com/mkdocs/mkdocs-redirects
+  # In case site re-structure is needed, this plugin will ensure permalink functionality
+  #- redirects:
+  #    redirect_maps:
+  #      'somepage.md' : 'otherpage.md'
+
 # Markdown extensions
 # See https://www.mkdocs.org/user-guide/configuration/#markdown_extensions
 #     https://squidfunk.github.io/mkdocs-material/setup/extensions/
@@ -94,8 +102,12 @@ markdown_extensions:
   pymdownx.tasklist:
     custom_checkbox: true
 
+  # Admonitions
+  # https://squidfunk.github.io/mkdocs-material/reference/admonitions/
   admonition: {}
 
+  # Details
+  # https://squidfunk.github.io/mkdocs-material/setup/extensions/python-markdown-extensions/#details
   pymdownx.details: {}
 
 # Copyright notice
index 5a04a468dfad36eb5b95839c0b39569cfa7a7bbc..a22e424374a89ca8e6b0a22a1d6baa3d1aa4507e 100755 (executable)
@@ -13,7 +13,7 @@ DEPENDENCIES="mkdocs apache2 python3-pip pandoc"
 DEPENDENCIES="$DEPENDENCIES tor python3-requests python3-bs4 python3-socks python3-pybtex"
 
 # PyPI dependencies
-DEPENDENCIES_PIP="mkdocs-bibtex mkdocs-material mkdocs-awesome-pages-plugin mkdocs-static-i18n"
+DEPENDENCIES_PIP="mkdocs-bibtex mkdocs-material mkdocs-awesome-pages-plugin mkdocs-static-i18n mkdocs-redirects"
 
 # Ensure an up-to-date system
 sudo apt-get update && sudo apt-get dist-upgrade -y && sudo apt-get autoremove -y && sudo apt-get clean