preppipe-docs/mkdocs.yml at main · PrepPipe/preppipe-docs · 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
site_name: '语涵编译器'
docs_dir: 'docs'
site_dir: 'generated'

theme:
  name: 'material'
  palette:
    primary: cyan
  language: 'zh'


markdown_extensions:
  - attr_list:
  - admonition:
  - pymdownx.details:
  - pymdownx.superfences: # 添加 mermaid 支持，用来画图
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true

plugins:
  - i18n:
      docs_structure: folder
      languages:
        - locale: zh
          default: true
          name: 简体中文
          site_name: 语涵编译器
          nav_translations:
            indexpage: 首页
            quickstart: 快速上手样例
            intro: 简介
            frontend: 剧本格式（前端）
            frontendcmddocs: 命令列表（自动生成）
            assetlistings: 内嵌素材列表（自动生成）
            middleend: 分析优化工具（中端）
            backend: 引擎支持（后端）
            develop: 开发者文档
        - locale: zh-Hant
          name: 繁體中文
          site_name: 語涵編譯器
          nav_translations:
            indexpage: 首頁
            quickstart: 快速上手範例
            intro: 簡介
            frontend: 劇本格式（前端）
            frontendcmddocs: 命令列表（自動生成）
            assetlistings: 內嵌素材列表（自動生成）
            middleend: 分析優化工具（中端）
            backend: 引擎支持（後端）
            develop: 開發者文檔
        - locale: en
          name: English
          site_name: PrepPipe Compiler
          nav_translations:
            indexpage: Home
            quickstart: Quickstart Examples
            intro: Introduction
            frontend: Script Format (Frontend)
            frontendcmddocs: Commands Listing (Auto-generated)
            assetlistings: Embedded Assets Listing (Auto-generated)
            middleend: Analysis and Opt Tools (Middleend)
            backend: Engine Support (Backend)
            develop: Developer Document
  - privacy
  - offline
  - search:
        separator: '[\s\u200b\-]'
  - ezlinks

  # - mkdocs-pdf

  # git-revision-date-localized 需要
  # 等这个插件支持 locale 字符串长于两个字母时再启用，现在 zh-Hant 会报错
  # - git-revision-date-localized:
  #    type: iso_date


nav:
  - indexpage: 'index.md'
  - quickstart:
    - "quickstart/pipeline.md"
  - intro:
    - "intro/why_preppipe.md"
    - "intro/usage.md"
    - "intro/functionality.md"
  - frontend:
    - "script/overview.md"
    - frontendcmddocs: "script/cmddocs.md"
    - assetlistings: "generated/script/assets.md"
  - middleend:
    - "middleend/overview.md"
    - "middleend/assetusage.md"
  - backend:
    - "engine/renpy.md"
    - "engine/webgal.md"
  - develop:
    - "develop/assetconfig.md"