Python-Project-Template/mkdocs.yml at master · SongshGeo/Python-Project-Template · 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
site_name: Python Project Template
site_description: A modern Python project template
site_author: SongshGeo
site_url: https://songshgeo.github.io/project_template/
docs_dir: docs/en
site_dir: site

repo_name: SongshGeo/project_template
repo_url: https://github.com/SongshGeo/project_template
edit_uri: edit/main/docs/en/

copyright: Copyright &copy; 2024 SongshGeo

nav:
  - Home: index.md
  - Quick Start: doc/quick-start.md
  - Tooling: doc/tools.md
  - Configuration: doc/configuration.md
  - Development: doc/development.md
  - Deployment: doc/deployment.md

theme:
  name: material
  palette:
    - scheme: default
      primary: blue
      accent: purple
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: blue
      accent: purple
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.suggest
    - search.highlight
    - search.share
    - toc.integrate
  icon:
    repo: fontawesome/brands/github

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - admonition
  - pymdownx.details
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

plugins:
  - search

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/SongshGeo/project_template
  alternate:
    - name: English
      link: /project_template/
      lang: en
    - name: 中文
      link: /project_template/zh/
      lang: zh