Omoospace/mkdocs.yml at main · OmooLab/Omoospace · 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
site_name: Omoospace Docs
site_url: https://docs.omoolab.xyz/omoospace/
site_author: OmooLab
site_description: Omoospace is a scalable directory structure solution for digital creation works.

repo_name: OmooLab/Omoospace
repo_url: https://github.com/OmooLab/Omoospace

nav:
  - Omoospace:
      - index.md
      - why.md
      - principles.md
      - yml.md
      - terms.md
      - cli.md
      - blender.md
  - How-to:
      - how-to-add-suffixes.md
      - how-to-setup-folders.md
      - how-to-backup.md
      - how-to-collaborate.md
      - how-to-version-control.md
  - 开发者:
      - develop.md
      - contribution.md
      - API Reference:
          - apis/omoospace.md
          - apis/functions.md
          - apis/common.md
          - apis/items.md
          - apis/validators.md
          - apis/utils.md

theme:
  name: material
  logo: assets/logo.png
  language: zh
  font:
    text: Open Sans
    code: Cascadia Code
  palette:
    # Palette toggle for automatic mode
    - media: "(prefers-color-scheme)"
      primary: black
      toggle:
        icon: fontawesome/solid/circle-half-stroke
        name: Switch to light mode

    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: black
      toggle:
        icon: fontawesome/regular/moon
        name: Switch to dark mode

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      toggle:
        icon: fontawesome/solid/moon
        name: Switch to system preference

  features:
    - header.autohide
    - navigation.footer
    - navigation.indexes
    - navigation.sections
    - navigation.tabs
    - navigation.tabs.sticky
    - content.code.copy
    - content.code.select

extra:
  version:
    provider: mike

extra_css:
  - stylesheets/extra.css

copyright: Copyright &copy; 2020 - 2024 Omoolab

plugins:
  - search
  - mkdocstrings
  - i18n:
      docs_structure: suffix
      languages:
        - locale: zh
          name: 中文
          default: true
        - locale: en
          name: English
          nav_translations:
            开发者: Develop

markdown_extensions:
  - mkdocs-click
  - admonition
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
  - pymdownx.tabbed:
      alternate_style: true