diff options
author | growupboron <shankhoghosh123@gmail.com> | 2020-09-11 17:18:57 +0530 |
---|---|---|
committer | Jan-Simon Moeller <jsmoeller@linuxfoundation.org> | 2020-09-11 12:11:56 +0000 |
commit | 4aad369c9728061c97b3de792286e743ee884b09 (patch) | |
tree | 14bddddeab334e3fdbdcf29446a87aa11cf6cd97 /theme/docs/customization.md | |
parent | 619a7e48085be1538c3b01eb93dcb9dc95bf0436 (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/docs/customization.md')
-rw-r--r-- | theme/docs/customization.md | 21 |
1 files changed, 21 insertions, 0 deletions
diff --git a/theme/docs/customization.md b/theme/docs/customization.md new file mode 100644 index 0000000..4523d01 --- /dev/null +++ b/theme/docs/customization.md @@ -0,0 +1,21 @@ +# Customization + + +For details about standard mkdocs options, see [MkDocs Configuration](http://www.mkdocs.org/user-guide/configuration/). + +In addition, the Windmill theme supports a few additional options, which may be +listed under the `extra:` key of `mkdocs.yml`. + +## Extra configuration options + +`extra.logo`: Path to a logo to include in the top bar next to the site name. + +`extra.version`: Version number to include right under the site name. + +`extra.article_nav_top`: Set to `false` to hide the Previous/Next navigation buttons above article contents. + +`extra.article_nav_bottom`: Set to `false` to hide the Previous/Next navigation buttons below article contents. + +`extra.history_buttons`: Include back/forward buttons in the top bar. This is + useful when the documentation site is included into a bare browser, e.g. into + an Electron-based application. |