There are few configuration options you can add to your config.yml|json|toml file
# (Optional) Set this to true if you use captial letters in file names
# (Optional) Set this to true to enable 'Last Modified by' date and git author
# information on 'doc' type pages.
# (Warnings) Theme is intended for documentation use, there for it doesn't render taxonomy.
# You can hide related warning with config below
disableKinds: ["taxonomy", "taxonomyTerm"]
# (Optional, default true) Show or hide table of contents globally
# You can also specify this parameter per page in front matter
# (Optional, default none) Set leaf bundle to render as side menu
# When not specified file structure and weights will be used
# (Optional, default docs) Specify section of content to render as menu
# You can also set value to "*" to render all sections to menu
# This value is duplicate of $link-color for making active link highlight in menu bundle mode
# BookMenuBundleActiveLinkColor: \#004ed0
# Include JS scripts in pages. Disabled by default.
# - Keep side menu on same scroll position during navigation
# Set source repository location.
# Used for 'Last Modified' and 'Edit this page' links.
# Enable "Edit this page" links for 'doc' page type.
# Disabled by default. Uncomment to enable. Requires 'BookRepo' param.
# Path must point to 'content' directory of repo.
You can specify additional params per page in front matter
# Set type to 'docs' if you want to render page outside of configured section or if you render section other than 'docs'
# Set page weight to re-arrange items in file-tree menu (if BookMenuBundle not set)
# (Optional) Set to mark page as flat section in file-tree menu (if BookMenuBundle not set)
# (Optional) Set to hide table of contents, overrides global value
There are few empty partials you can override in layouts/partials/
| Partial | Placement |
| – | – |
| layouts/partials/docs/inject/head.html | Before closing <head> tag |
| layouts/partials/docs/inject/body.html | Before closing <body> tag |
| layouts/partials/docs/inject/menu-before.html | At the beginning of <nav> menu block |
| layouts/partials/docs/inject/menu-after.html | At the end of <nav> menu block |
Contributions are welcome and I will review and consider pull requests. Primary goals are:
- Keep it simple
- Keep minimal (or zero) default configuration
- Avoid interference with user-defined layouts
Feel free to open issue if you missing some configuration or customization option.