aboutsummaryrefslogtreecommitdiffstats
path: root/theme/mkdocs.yml
diff options
context:
space:
mode:
authorgrowupboron <shankhoghosh123@gmail.com>2020-09-11 17:18:57 +0530
committerJan-Simon Moeller <jsmoeller@linuxfoundation.org>2020-09-11 12:11:56 +0000
commit4aad369c9728061c97b3de792286e743ee884b09 (patch)
tree14bddddeab334e3fdbdcf29446a87aa11cf6cd97 /theme/mkdocs.yml
parent619a7e48085be1538c3b01eb93dcb9dc95bf0436 (diff)
Simplified doc-site generationjellyfish_9.99.4jellyfish/9.99.49.99.4
Updated theme to windmill Using Mkdocs static site generator Deployed on readthedocs Signed-off-by: growupboron <shankhoghosh123@gmail.com> Change-Id: If62eaaea1855c91b64f687900f54eba6bc1caee8 Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/25236 Reviewed-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org> Tested-by: Jan-Simon Moeller <jsmoeller@linuxfoundation.org>
Diffstat (limited to 'theme/mkdocs.yml')
-rw-r--r--theme/mkdocs.yml32
1 files changed, 32 insertions, 0 deletions
diff --git a/theme/mkdocs.yml b/theme/mkdocs.yml
new file mode 100644
index 0000000..3bf8a9f
--- /dev/null
+++ b/theme/mkdocs.yml
@@ -0,0 +1,32 @@
+site_name: 'Windmill MkDocs Theme'
+site_description: 'MkDocs theme focused on navigation and usability.'
+site_author: 'Dmitry S'
+
+repo_url: https://github.com/gristlabs/mkdocs-windmill
+
+theme:
+ name: null
+ custom_dir: mkdocs_windmill
+ # Copy settings from mkdocs_theme.yml, which is ignored by custom_dir themes.
+ static_templates: [404.html]
+ search_index_only: true
+ include_search_page: true
+
+# This should be renamed to nav for mkdocs 1.0+
+pages:
+- Usage: index.md
+- Customization: customization.md
+- Samples:
+ - Sample Page A: sample-a.md
+ - Sample Subfolder:
+ - Sample Subpage A1: a/sample-a1.md
+ - Sample Subpage A2: a/sample-a2.md
+ - Sample Page B: sample-b.md
+
+markdown_extensions:
+ - toc:
+ permalink: '#'
+
+extra:
+ history_buttons: false
+ version: v1.0.4