diff options
| author |   Shankho Boron Ghosh <shankhoghosh123@gmail.com> | 2020-11-06 20:20:45 +0530 |
|---|---|---|
| committer |   Jan-Simon Moeller <jsmoeller@linuxfoundation.org> | 2020-11-10 15:25:18 +0000 |
| commit | 992be2143539df943ba835ffa6b1165e5c841119 (patch) | |
| tree | 613c05e71974bed2ff8a7bf96e747ac7c6d23571 /theme/docs/customization.md | |
| parent | 1aeb863a111b8ea1b48d56d4a563c8398082858e (diff) | |
Added Halibut Branchhalibut
Meta redirects to http://old-docs.automotivelinux.org/docs/en/halibut/getting_started/
Bug-AGL: [SPEC-3633]
Signed-off-by: Shankho Boron Ghosh <shankhoghosh123@gmail.com>
Change-Id: I2f106628e603cb207d1734f521b5e8d1fb4164dc
Reviewed-on: https://gerrit.automotivelinux.org/gerrit/c/AGL/documentation/+/25515
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. |