From 4aad369c9728061c97b3de792286e743ee884b09 Mon Sep 17 00:00:00 2001 From: growupboron Date: Fri, 11 Sep 2020 17:18:57 +0530 Subject: Simplified doc-site generation Updated theme to windmill Using Mkdocs static site generator Deployed on readthedocs Signed-off-by: growupboron Change-Id: If62eaaea1855c91b64f687900f54eba6bc1caee8 Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/25236 Reviewed-by: Jan-Simon Moeller Tested-by: Jan-Simon Moeller --- theme/mkdocs.yml | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 theme/mkdocs.yml (limited to 'theme/mkdocs.yml') 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 -- cgit 1.2.3-korg