TandoorRecipes/mkdocs.yml
mh166 a71bba307e
Enable search plugin for docs
I think mkdocs-material's search function would be a great addition to make the documentation even more accessible. At least I was looking for some info just moments ago and would've liked a search bar.

From my own projects, I remembered that mkdocs-material does come with the search search plugin enabled by default. But it must be re-added to mkdocs.yml when other plugins are used. So I did. Hope this helps. :)
2022-11-01 11:44:56 +01:00

50 lines
1.2 KiB
YAML

site_name: Tandoor Recipes
site_description: Tandoor Recipe Documentation
site_author: vabene1111
repo_url: https://github.com/vabene1111/recipes
edit_uri: https://github.com/vabene1111/recipes/tree/develop/docs
extra_css:
- stylesheets/extra.css
theme:
name: material
repo: fontawesome/brands/github
logo: logo_color.svg
favicon: logo_color.svg
palette:
scheme: slate
markdown_extensions:
- admonition
- pymdownx.highlight
- pymdownx.superfences
plugins:
- include-markdown
- search
nav:
- Home: 'index.md'
- Installation:
- Docker: install/docker.md
- Unraid: install/unraid.md
- Synology: install/synology.md
- Kubernetes: install/kubernetes.md
- KubeSail or PiBox: install/kubesail.md
- Manual: install/manual.md
- Other setups: install/other.md
- Features:
- Templating: features/templating.md
- Shopping: features/shopping.md
- Authentication: features/authentication.md
- Storages and Sync: features/external_recipes.md
- Import/Export: features/import_export.md
- System:
- Updating: system/updating.md
- Permission System: system/permissions.md
- Backup: system/backup.md
- Contributing: contribute.md
- FAQ: faq.md