Docs/mkdocs.yml
2024-05-26 14:26:50 +02:00

110 lines
3.1 KiB
YAML

site_name: Garbage Reminder
repo_url: https://git.end-play.xyz/GarbageReminder
repo_name: GarbageReminder
nav:
- Home:
- index.md
- Start using: start-using.md
- Deployment: deployment.md
- API:
- api/index.md
- Installation: api/installation.md
- Configuration: api/configuration.md
- Daemonizing: api/daemonizing.md
- Feeding data: api/feeding-data.md
- Upgrading: api/upgrading.md
- Telegram Bot:
- bot_telegram/index.md
- Installation: bot_telegram/installation.md
- Configuration: bot_telegram/configuration.md
- Feeding data: bot_telegram/feeding-data.md
- Upgrading: bot_telegram/upgrading.md
- Community:
- community/index.md
- Contributing: community/contributing.md
- Reporting a bug: community/report-bug.md
- Adding translations: community/translate.md
- Get in touch: community/contact.md
- Public instance:
- community/public/index.md
- Adding entries: community/public/entries.md
- Adding locations: community/public/locations.md
- Report a problem: community/public/report.md
- Privacy policy: community/public/privacy-policy.md
- Terms of service: community/public/terms-of-service.md
extra:
social:
- icon: fontawesome/brands/git-alt
link: https://git.end-play.xyz/GarbageReminder
- icon: fontawesome/solid/globe
link: https://api.garbagebot.eu/docs
- icon: fontawesome/brands/telegram
link: https://garbagebot.eu/telegram
- icon: fontawesome/brands/discord
link: https://garbagebot.eu/discord
extra_css:
- stylesheets/extra.css
theme:
name: material
logo: assets/logo.png
favicon: assets/favicon.png
features:
- announce.dismiss
- content.action.edit
- content.action.view
- content.code.annotate
- content.code.copy
# - content.code.select
# - content.footnote.tooltips
# - content.tabs.link
- content.tooltips
# - header.autohide
# - navigation.expand
- navigation.footer
- navigation.indexes
# - navigation.instant
# - navigation.instant.prefetch
# - navigation.instant.progress
# - navigation.prune
- navigation.sections
- navigation.tabs
# - navigation.tabs.sticky
- navigation.top
- navigation.tracking
- search.highlight
- search.share
- search.suggest
- toc.follow
# - toc.integrate
palette:
- media: "(prefers-color-scheme)"
toggle:
icon: material/brightness-auto
name: Switch to light mode
- media: "(prefers-color-scheme: light)"
scheme: default
primary: custom
accent: custom
toggle:
icon: material/brightness-7
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: custom
accent: custom
toggle:
icon: material/brightness-5
name: Switch to system preference
font:
text: Roboto
code: Roboto Mono
icon:
logo: logo
markdown_extensions:
- attr_list
- pymdownx.details
- pymdownx.superfences
- pymdownx.tabbed:
alternate_style: true
- toc:
permalink: true