boilerplate-py/mkdocs.yaml

49 lines
1.1 KiB
YAML

copyright: "© 2023 ${REPO_OWNER_TITLE}"
site_name: "${REPO_NAME}"
site_description: "${REPO_DESCRIPTION}"
site_url: "http://${REPO_OWNER_LOWER}.github.io/${REPO_NAME_LOWER}"
repo_name: "${REPO_OWNER_LOWER}/${REPO_NAME_LOWER}"
repo_url: "https://github.com/${REPO_OWNER_LOWER}/${REPO_NAME_LOWER}"
theme:
language: en
name: material
palette:
- media: "(prefers-color-scheme: light)"
scheme: default
accent: red
toggle:
icon: material/brightness-7
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
accent: red
toggle:
icon: material/brightness-4
name: Switch to light mode
extra_css:
- css/extra.css
plugins:
- search
- mkdocstrings:
handlers:
python:
options:
line_length: 80
show_source: false
show_root_toc_entry: false
separate_signature: true
show_signature_annotations: true
markdown_extensions:
- admonition
- codehilite
- extra
- pymdownx.superfences
- toc:
permalink: true
nav:
- Home: index.md