python-template-uv/mkdocs.yml at main · bassemkaroui/python-template-uv · 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
120
121
122
123
124
125
site_name: python-template-uv
repo_url: https://github.com/bassemkaroui/python-template-uv
site_url: https://bassemkaroui.github.io/python-template-uv
repo_name: bassemkaroui/python-template-uv
site_description: A Copier-powered template for creating Python packages managed with uv.
site_author: Bassem Karoui
edit_uri: edit/main/docs/
copyright: Maintained by <a href="https://github.com/bassemkaroui">Bassem Karoui</a>.

nav:
  - Home: index.md
  - Getting Started:
      - Prerequisites: getting-started/prerequisites.md
      - Quickstart: getting-started/quickstart.md
      - Updating: getting-started/updating.md
  - Features:
      - Overview: features/overview.md
      - Task Runner: features/task-runner.md
      - Quality Tools: features/quality-tools.md
      - Testing: features/testing.md
      - Documentation: features/documentation.md
      - Docker: features/docker.md
      - CI/CD: features/ci-cd.md
      - Optional Features: features/optional.md
  - Configuration:
      - Template Variables: configuration/variables.md

plugins:
  - search
  - minify:
      minify_html: !ENV [DEPLOY, false]
  - privacy
  - social:
      enabled: !ENV [CI, false]
  - git-revision-date-localized:
      enable_creation_date: true

theme:
  name: material
  custom_dir: docs/overrides
  font:
    text: Inter
    code: JetBrains Mono
  features:
    - navigation.footer
    - navigation.indexes
    - navigation.instant
    - navigation.instant.prefetch
    - navigation.instant.progress
    - navigation.path
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.top
    - navigation.tracking
    - toc.follow
    - search.suggest
    - search.share
    - search.highlight
    - content.tabs.link
    - content.code.annotate
    - content.code.copy
    - content.tooltips
    - content.footnote.tooltips
  palette:
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/lightbulb-auto
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: white
      accent: deep orange
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      accent: deep orange
      toggle:
        icon: material/brightness-4
        name: Switch to system preference
  icon:
    repo: fontawesome/brands/github
    logo: material/language-python

extra_css:
  - css/overrides.css

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/bassemkaroui/python-template-uv

markdown_extensions:
  - toc:
      permalink: true
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - admonition
  - footnotes
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.mark
  - attr_list
  - def_list
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.blocks.tab:
      alternate_style: true
  - pymdownx.tabbed:
      alternate_style: true
      slugify: !!python/object/apply:pymdownx.slugs.slugify
        kwds:
          case: lower
  - pymdownx.tasklist:
      custom_checkbox: true
  - callouts:
      strip_period: no
  - md_in_html