elliebot/docs/mkdocs.yml

80 lines
No EOL
2.1 KiB
YAML

site_name: EllieBot docs
site_url: https://docs.elliebot.net
repo_url: 'https://toastielab.dev/EllieBotDevs/elliebot'
site_author: Toastie_t0ast
docs_dir: 'md'
copyright: Copyright © 2018 - 2025 Toastie_t0ast & EllieBotDevs
theme:
name: material
palette:
- media: "(prefers-color-scheme: light)"
scheme: default
primary: indigo
accent: blue
toggle:
icon: material/weather-sunny
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: black
accent: blue
toggle:
icon: material/weather-night
name: Switch to light mode
features:
- navigation.instant
- navigation.expand
- navigation.top
font:
text: Source Sans 3
code: Source Code Pro
logo: assets/favicon.png
favicon: assets/favicon.png
icon:
repo: material/git
extra:
homepage: https://elliebot.net
plugins:
- search
- exclude:
glob:
- 'guides/vps-linux-guide.md'
- 'snippets/supported-platforms.md'
markdown_extensions:
- attr_list
- codehilite:
guess_lang: false
- toc:
permalink: true
- pymdownx.betterem:
smart_enable: all
- admonition
- pymdownx.inlinehilite
- pymdownx.superfences
- pymdownx.blocks.tab:
alternate_style: true
- pymdownx.snippets
- pymdownx.details
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
options:
custom_icons:
- overrides/.icons
nav:
- Home: index.md
- Guides:
- Desktop Guide: guides/desktop-guide.md
- CLI Guide: guides/cli-guide.md
- Docker Guide: guides/docker-guide.md
- Source Guide: guides/source-guide.md
- Commands:
- Commands List: https://commands.elliebot.net
- Features Explained:
- Basic Creds: creds-guide.md
- Marmalade System:
- marmalade/getting-started.md
- marmalade/creating-a-marmalade.md
- marmalade/canary-lifecycle.md
- Donate: donate.md