PyWorkout/mkdocs.yml at main · willtheorangeguy/PyWorkout · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
# Documentation configuration for PyWorkout.

INHERIT: .mkdocs-shared/shared/mkdocs.base.yml

site_name: 'PyWorkout'
site_description: 'A minimal CLI to keep you inspired during your workout! Easily used and customized, with support for multiple workout plans, different muscle groups and video workouts.'
site_author: willtheorangeguy
site_url: https://williamvdg.me/PyWorkout/

repo_url: https://github.com/willtheorangeguy/PyWorkout
repo_name: willtheorangeguy/PyWorkout
edit_uri: edit/main/docs/

copyright: Copyright &copy; willtheorangeguy

nav:
  - Home: index.md
  - 'Quickstart': 'quickstart.md'
  - 'Installation': 'installation.md'
  - 'Usage': 'usage.md'
  - 'Configuration': 'configuration.md'
  - 'Architecture': 'architecture.md'
  - 'Development': 'development.md'
  - 'Testing': 'testing.md'
  - 'FAQ': 'faq.md'
  - 'Troubleshooting': 'troubleshooting.md'
  - 'Roadmap': 'roadmap.md'
  - 'Commands': 'commands.md'
  - 'PyWorkout': 'internal/known-issues.md'
  - Changelog: changelog.md
  - License: license.md
  - Contributing: https://github.com/willtheorangeguy/.github/blob/main/CONTRIBUTING.md
  - Code of Conduct: https://github.com/willtheorangeguy/.github/blob/main/CODE_OF_CONDUCT.md
  - Security: https://github.com/willtheorangeguy/.github/blob/main/SECURITY.md

exclude_docs: |
  docs.instructions.md