python-boilerplate.github.io/mkdocs.yml at main · python-boilerplate/python-boilerplate.github.io · 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
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
site_name: python boilerplate
repo_url: https://github.com/python-boilerplate
repo_name: python-boilerplate

nav:
  - Home: index.md
  - Templates:
    - uv-template:
      - Home:
        - Overview: uv-template/index.md
        - Changelog: uv-template/home/changelog.md
        - License: uv-template/home/license.md
        - Contributing: uv-template/home/contributing.md
      - Usage:
        - Options: uv-template/usage/index.md
        - Commands: uv-template/usage/commands.md
      - Features:
        - Overview: uv-template/features/index.md
        - Python:
          - Python 3.10+: uv-template/features/python.md
        - UV: uv-template/features/uv.md
        - Docker: uv-template/features/docker.md
        - CI/CD:
          - GitHub Actions: uv-template/features/ci/github_actions.md
          - GitLab CI: uv-template/features/ci/gitlab_ci.md
        - Dev Containers: uv-template/features/devcontainers.md
        - Code Quality:
          - Ruff: uv-template/features/code_quality/ruff.md
          - MyPy: uv-template/features/code_quality/mypy.md
          - Pytest: uv-template/features/code_quality/pytest.md
          - Vermin: uv-template/features/code_quality/vermin.md
        - Pre-commit Hooks: uv-template/features/pre-commit.md
        - Commitizen: uv-template/features/commitizen.md
        - Environment Management: uv-template/features/environment.md
        - MkDocs: uv-template/features/mkdocs.md
        - Makefile: uv-template/features/makefile.md
      - Reference:
        - Project Structure: uv-template/reference/project_structure.md
    - poetry-template:
      - Home:
        - Overview: poetry-template/index.md
        - Changelog: poetry-template/home/changelog.md
        - License: poetry-template/home/license.md
        - Contributing: poetry-template/home/contributing.md
      - Usage:
        - Options: poetry-template/usage/index.md
        - Commands: poetry-template/usage/commands.md
      - Features:
        - Overview: poetry-template/features/index.md
        - Python:
          - Python 3.10+: poetry-template/features/python.md
        - UV: poetry-template/features/uv.md
        - Docker: poetry-template/features/docker.md
        - CI/CD:
          - GitHub Actions: poetry-template/features/ci/github_actions.md
          - GitLab CI: poetry-template/features/ci/gitlab_ci.md
        - Dev Containers: poetry-template/features/devcontainers.md
        - Code Quality:
          - Ruff: poetry-template/features/code_quality/ruff.md
          - MyPy: poetry-template/features/code_quality/mypy.md
          - Pytest: poetry-template/features/code_quality/pytest.md
          - Vermin: poetry-template/features/code_quality/vermin.md
        - Pre-commit Hooks: poetry-template/features/pre-commit.md
        - Commitizen: poetry-template/features/commitizen.md
        - Environment Management: poetry-template/features/environment.md
        - MkDocs: poetry-template/features/mkdocs.md
        - Makefile: poetry-template/features/makefile.md
      - Reference:
        - Project Structure: poetry-template/reference/project_structure.md


theme:
  name: material
  features:
    - navigation.footer
    - navigation.tabs
    - content.code.copy
    - content.code.select
    - navigation.tabs.sticky
    - navigation.sections
    - navigation.tracking
    - toc.follow

  palette:
  - media: "(prefers-color-scheme)"
    toggle:
      icon: material/brightness-auto
      name: Switch to light mode
  - media: "(prefers-color-scheme: light)"
    scheme: default
    primary: teal
    accent: purple
    toggle:
      icon: material/weather-sunny
      name: Switch to dark mode
  - media: "(prefers-color-scheme: dark)"
    scheme: slate
    primary: black
    accent: lime
    toggle:
      icon: material/weather-night
      name: Switch to system preference


plugins:
  - search

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true