diff options
| author |   Shankho Boron Ghosh <shankhoghosh123@gmail.com> | 2020-11-04 20:48:01 +0530 |
|---|---|---|
| committer |   Jan-Simon Moeller <jsmoeller@linuxfoundation.org> | 2020-11-10 22:43:20 +0000 |
| commit | 6b1ab1c2161da3cd7a3d54fe684906e73da23674 (patch) | |
| tree | 43ffb329b1c418251e8fa7c140b3c5717c7365af /theme/docs/customization.md | |
| parent | d03401d2cdcddf2bc24f4eff0954f69fa5aa61ec (diff) | |
Added Icefish Branchicefish_9.0.4icefish/9.0.49.0.4icefish
Meta redirects to http://old-docs.automotivelinux.org/docs/en/icefish/getting_started/
Bug-AGL: [SPEC-3633]
Signed-off-by: Shankho Boron Ghosh <shankhoghosh123@gmail.com>
Change-Id: Ie6bfbc5821b8c158fb92a076d143d8e495ac5d89
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/25509
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. |