Documentation-Templete/mkdocs.yml at main · perseverance-tech-tw/Documentation-Templete · 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
site_name: Your Project Name
site_url: https://your-username.github.io/your-project-docs/
repo_url: https://github.com/your-username/your-project
repo_name: Your Project

theme:
  name: material
  custom_dir: overrides
  language: en
  favicon: favicon.ico
  font:
    text: Space Grotesk
    code: JetBrains Mono
  palette:
    - scheme: default
      primary: blue
      accent: amber
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: blue
      accent: amber
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  logo: assets/images/ui/logo.png
  features:
    - navigation.top
    - content.code.copy
    - toc.integrate

extra_css:
  - stylesheets/extra.css

extra_javascript:
  - javascripts/scroll-animate.js

extra:
  version:
    provider: mike
  # Social links (uncomment and customize)
  # social:
  #   - icon: fontawesome/brands/github
  #     link: https://github.com/your-username
  #   - icon: fontawesome/brands/twitter
  #     link: https://twitter.com/your-username

# Copyright notice (shown in footer)
copyright: "&copy; 2026 Perseverance Technology Co., Ltd. All rights reserved."

plugins:
  - search

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - attr_list
  - md_in_html
  - tables
  - toc:
      permalink: true

nav:
  - Home: index.md
  - Release Notes: release-notes/index.md
  - Installation Guide: install/index.md
  - Overview: definition/index.md
  - Features: features/index.md
  - Usage Guide:
    - usage/index.md
    - MkDocs + Mike Guide: usage/mkdocs-mike-guide.md
  - Operations: operations/index.md