Files
MIND/project_management/mkdocs.yml
2023-07-03 17:01:15 +02:00

86 lines
1.8 KiB
YAML

# Site Details
site_name: MIND Docs
site_description: The official guide for MIND
site_author: Casvt
repo_url: https://github.com/Casvt/MIND
edit_uri: blob/Development/docs/
repo_name: Casvt/MIND
docs_dir: ../docs
extra_css:
- assets/css/extra.css
# Site appearance (logos, colours, icons)
theme:
name: material
language: en
code_wrap: true
features:
- content.tabs.link
- content.code.copy
- header.autohide
- navigation.expand
- navigation.indexes
- navigation.instant
- navigation.sections
- navigation.tabs
- navigation.tabs.sticky
- navigation.top
- navigation.tracking
favicon: assets/img/favicon.svg
logo: assets/img/favicon.svg
palette:
# Light mode
- media: "(prefers-color-scheme: light)"
scheme: MIND
toggle:
icon: material/toggle-switch-off-outline
name: Switch to dark mode
# Dark mode
- media: "(prefers-color-scheme: dark)"
scheme: MIND-dark
toggle:
icon: material/toggle-switch
name: Switch to light mode
# Markdown extensions
markdown_extensions:
- abbr
- attr_list
- meta
- pymdownx.details
- pymdownx.highlight:
guess_lang: true
anchor_linenums: true
- pymdownx.inlinehilite
- pymdownx.keys
- pymdownx.saneheaders
- pymdownx.smartsymbols
- pymdownx.snippets
- pymdownx.superfences
- pymdownx.tabbed:
alternate_style: true
- sane_lists
- toc:
permalink: true
toc_depth: 5
- tables
# mkdocs function extensions
plugins:
- search
- git-revision-date-localized:
type: timeago
locale: en
fallback_to_build_date: false
# Navigation Layout
nav:
- Home: index.md
- Getting Started:
- Installation: installation.md
- Setup After Installation: setup_after_installation.md
- Other Docs:
- API: api.md
- Backup Your Data: backup_your_data.md