docs/customization.md

   1 # Customization
   2
   3
   4 For details about standard mkdocs options, see [MkDocs Configuration](http://www.mkdocs.org/user-guide/configuration/).
   5
   6 In addition, the Windmill theme supports a few additional options, which may be
   7 listed under the `extra:` key of `mkdocs.yml`.
   8
   9 ## Extra configuration options
  10
  11 `extra.logo`: Path to a logo to include in the top bar next to the site name.
  12
  13 `extra.version`: Version number to include right under the site name.
  14
  15 `extra.article_nav_top`: Set to `false` to hide the Previous/Next navigation buttons above article contents.
  16
  17 `extra.article_nav_bottom`: Set to `false` to hide the Previous/Next navigation buttons below article contents.
  18
  19 `extra.history_buttons`: Include back/forward buttons in the top bar. This is
  20   useful when the documentation site is included into a bare browser, e.g. into
  21   an Electron-based application.