aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSilvio Rhatto <rhatto@riseup.net>2024-09-14 10:42:26 -0300
committerSilvio Rhatto <rhatto@riseup.net>2024-09-14 10:42:26 -0300
commit88d34eafbce4980da870f6d00d75788eb1d44b09 (patch)
treed25e3443d7f1c0c8ea23d3d274cc689eee0b0d65
parente60a96ca0b0ee6b68d17a7f3ada559432a5f4ba8 (diff)
downloadtemplates-88d34eafbce4980da870f6d00d75788eb1d44b09.tar.gz
templates-88d34eafbce4980da870f6d00d75788eb1d44b09.tar.bz2
MkDocs config improvements
-rw-r--r--mkdocs.yml14
-rwxr-xr-xscripts/provision2
2 files changed, 14 insertions, 2 deletions
diff --git a/mkdocs.yml b/mkdocs.yml
index 7ae48fd..0f00786 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -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
diff --git a/scripts/provision b/scripts/provision
index 5a04a46..a22e424 100755
--- a/scripts/provision
+++ b/scripts/provision
@@ -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