Add awesome pages plugin; use awesome pages to fix capitalization err…

…ors in the mkdocs nav (primarily acronyms being shown in lower case) (microsoft#983) Co-authored-by: Tess Ferrandez <tferrand@microsoft.com>
wirsich-forks · Aug 15, 2023 · 58a00e2 · 58a00e2
1 parent b36be65
commit 58a00e2
Show file tree

Hide file tree

Showing 6 changed files with 22 additions and 0 deletions.
diff --git a/docs/automated-testing/.pages b/docs/automated-testing/.pages
@@ -0,0 +1,6 @@
+nav:
+    - CDC testing: cdc-testing
+    - End-to-end testing: e2e-testing
+    - ...
+    - UI testing: ui-testing
+
diff --git a/docs/continuous-delivery/.pages b/docs/continuous-delivery/.pages
@@ -0,0 +1,5 @@
+nav:
+  - Azure DevOps: azure-devops
+  - DevOps provider recipes: devops-provider-recipes
+  - GitOps: gitops
+  - ...
diff --git a/docs/continuous-integration/.pages b/docs/continuous-integration/.pages
@@ -0,0 +1,5 @@
+nav:
+  - CI in data science: ci-in-data-science
+  - DevSecOps: dev-sec-ops
+  - Dev conainters: devcontainers
+  - markdown-linting
diff --git a/docs/design/diagram-types/.pages b/docs/design/diagram-types/.pages
@@ -0,0 +1,3 @@
+nav:
+  - Design diagram templates: DesignDiagramsTemplates
+  - ...
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -23,6 +23,7 @@ theme:
 plugins:
   - search
   - git-revision-date-localized
+  - awesome-pages
 
 markdown_extensions:
   - meta

diff --git a/requirements-docs.txt b/requirements-docs.txt
@@ -4,3 +4,5 @@ pymdown-extensions==9.4.*
 markdown==3.3.*
 mdx_truly_sane_lists==1.2
 mkdocs-git-revision-date-localized-plugin==1.0.*
+mkdocs-awesome-pages-plugin==2.9.1
+