You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
docs/mkdocs.yml

71 lines
1.9 KiB
YAML

site_name: Docs St1t.ru
repo_url: https://st1t.ru/thest1tch/docs
repo_name: thest1tch/docs
edit_uri: edit/main/docs/
theme:
name: material
custom_dir: overrides
language: en
#logo: images/site/logo.png
favicon: images/assets/favicon.png
icon:
repo: fontawesome/brands/github
logo: fontawesome/regular/folder-open
palette:
- scheme: default
primary: blue
accent: teal
toggle:
icon: material/weather-night
name: Switch to dark mode
- scheme: slate
toggle:
icon: material/weather-sunny
name: Switch to light mode
font:
code: Jet Brains Mono
features:
- navigation.instant
- navigation.sections # prevents collapsible sections
- navigation.indexes # section index pages
- navigation.expand #expands sections by default
# insiders only
# - search.suggest
plugins:
- search
- redirects:
redirect_maps:
user-guide/plugins.md: dev-guide/plugins.md
user-guide/custom-themes.md: dev-guide/themes.md
user-guide/styling-your-docs.md: user-guide/choosing-your-theme.md
markdown_extensions:
- abbr
- admonition # enables coloured blocks mid article
- attr_list # improves image handling
- pymdownx.details # enables collapsible admonitions
- footnotes
- meta # adds support for front matter
- toc:
permalink: true
toc_depth: 4
- pymdownx.highlight: # code highlighting
linenums: true
- pymdownx.tabbed # enables tabs for embedded blocks
- pymdownx.snippets
- pymdownx.superfences # allows for the nesting of code blocks inside other blocks
- pymdownx.keys
copyright: 2023 © TheSt1tch - Licensed under GPLv3
nav:
- Welcome: 'index.md'
- 1. Docker Compose:
- Linx Server: 'docker-compose/linx-server.md'
#- 2. Docker:
#- 3. Mediaserver:
#- 4. Proxmox:
#- 5. Synology:
#- 6. Hardware: