145 lines
3.2 KiB
YAML
145 lines
3.2 KiB
YAML
# Project information
|
|
site_name: ScStw Documentation
|
|
site_url: https://scstw.itsblue.de
|
|
site_author: Itsblue Development
|
|
site_description: >-
|
|
The ScStw is a fully featured, yet affordable and easy to use speed climbing stopwatch.
|
|
# Repository
|
|
repo_name: ScStw source code
|
|
repo_url: https://itsblue.dev/ScStw
|
|
edit_uri: ""
|
|
|
|
# Copyright
|
|
copyright: Copyright © 2018 - 2022 Itsblue Development
|
|
|
|
# Page tree
|
|
nav:
|
|
- Erste Schritte:
|
|
- Einleitung: index.md
|
|
- Komponenten: getting-started/components.md
|
|
- Softwareinstallation: getting-started/software-setup.md
|
|
- Benutzeranleitung:
|
|
- Aufbau: user-guide/setup.md
|
|
- Grundlagen: user-guide/basics.md
|
|
- Konfigration eines Rennens: user-guide/race-configuration.md
|
|
#- Entwickleranleitung:
|
|
- Impressum:
|
|
- Team: about/team.md
|
|
- Kontakt: about/contact.md
|
|
- Lizenz: about/license.md
|
|
|
|
|
|
# Dirs
|
|
docs_dir: docs
|
|
site_dir: site
|
|
|
|
# Configuration
|
|
theme:
|
|
name: material
|
|
|
|
# Static files
|
|
static_templates:
|
|
- 404.html
|
|
|
|
# Don't include MkDocs' JavaScript
|
|
include_search_page: false
|
|
search_index_only: true
|
|
|
|
# Default values, taken from mkdocs_theme.yml
|
|
language: de
|
|
features:
|
|
- content.code.annotate
|
|
#- content.tabs.link
|
|
# - header.autohide
|
|
# - navigation.expand
|
|
#- navigation.indexes
|
|
# - navigation.instant
|
|
#- navigation.sections
|
|
- navigation.tabs
|
|
# - navigation.tabs.sticky
|
|
#- navigation.top
|
|
#- navigation.tracking
|
|
- search.highlight
|
|
- search.share
|
|
- search.suggest
|
|
# - toc.integrate
|
|
palette:
|
|
- scheme: default
|
|
primary: black
|
|
accent: blue
|
|
toggle:
|
|
icon: material/toggle-switch-off-outline
|
|
name: Switch to dark mode
|
|
- scheme: slate
|
|
primary: black
|
|
accent: blue
|
|
toggle:
|
|
icon: material/toggle-switch
|
|
name: Switch to light mode
|
|
font:
|
|
text: Roboto
|
|
code: Roboto Mono
|
|
favicon: assets/favicon.png
|
|
logo: assets/logo.png
|
|
|
|
# Plugins
|
|
plugins:
|
|
- search
|
|
#- pdf-export
|
|
#- redirects:
|
|
#redirect_maps:
|
|
#changelog/insiders.md: insiders/changelog.md
|
|
- minify:
|
|
minify_html: true
|
|
|
|
# Customization
|
|
extra:
|
|
social:
|
|
- icon: fontawesome/solid/code
|
|
link: https://itsblue.dev/ScStw/documentation
|
|
|
|
#alternate:
|
|
|
|
# Switch to English
|
|
#- name: English
|
|
# link: en/
|
|
# lang: en
|
|
|
|
# Switch to German
|
|
#- name: Deutsch
|
|
# link: de/
|
|
# lang: de
|
|
|
|
# Extensions
|
|
markdown_extensions:
|
|
- markdown.extensions.admonition
|
|
- markdown.extensions.attr_list
|
|
- markdown.extensions.codehilite:
|
|
guess_lang: false
|
|
- markdown.extensions.def_list
|
|
- markdown.extensions.footnotes
|
|
- markdown.extensions.meta
|
|
- markdown.extensions.toc:
|
|
permalink: true
|
|
- pymdownx.arithmatex
|
|
- pymdownx.betterem:
|
|
smart_enable: all
|
|
- pymdownx.caret
|
|
- pymdownx.critic
|
|
- pymdownx.details
|
|
- pymdownx.emoji:
|
|
emoji_index: !!python/name:materialx.emoji.twemoji
|
|
emoji_generator: !!python/name:materialx.emoji.to_svg
|
|
- pymdownx.inlinehilite
|
|
- pymdownx.keys
|
|
- pymdownx.magiclink
|
|
- pymdownx.mark
|
|
- pymdownx.smartsymbols
|
|
- pymdownx.snippets:
|
|
check_paths: true
|
|
- pymdownx.superfences
|
|
- pymdownx.tabbed
|
|
- pymdownx.tasklist:
|
|
custom_checkbox: true
|
|
- pymdownx.tilde
|
|
- attr_list |