LatticeSVG/mkdocs.yml at main · Qalxry/LatticeSVG · 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
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
site_name: LatticeSVG
site_description: Grid-based vector layout engine — CSS Grid layout to SVG/PNG
site_url: https://Qalxry.github.io/LatticeSVG/
repo_url: https://github.com/Qalxry/LatticeSVG
repo_name: LatticeSVG

strict: !ENV [MKDOCS_STRICT, false]

theme:
  name: material
  language: en
  palette:
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: indigo
      accent: indigo
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  font:
    text: Noto Sans SC
    code: JetBrains Mono
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - navigation.indexes
    - content.code.copy
    - content.tabs.link
    - search.suggest
    - search.highlight
    - toc.follow
  icon:
    repo: fontawesome/brands/github

plugins:
  - search
  - i18n:
      docs_structure: suffix
      languages:
        - locale: en
          default: true
          name: English
          build: true
        - locale: zh
          name: 简体中文
          build: true
          nav_translations:
            Home: 首页
            Getting Started: 快速开始
            Installation: 安装
            Quick Start: 快速上手
            Core Concepts: 核心概念
            Tutorials: 教程
            Grid Layout: Grid 布局
            Text & Typography: 文本排版
            Node Types: 节点类型
            Styling & Visuals: 样式与视觉
            Rich Text & Markup: 富文本与标记
            Advanced Usage: 高级用法
            Reference: 参考
            CSS Properties: CSS 属性
            Built-in Templates: 内置模板
            API Reference: API 参考
            Overview: 概览
            Nodes: 节点
            Renderer: 渲染器
            Style System: 样式系统
            Text Engine: 文本引擎
            Layout Engine: 布局引擎
            Markup Parser: 标记解析
            Math: 数学公式
            Changelog: 更新日志
  - mkdocstrings:
      default_handler: python
      handlers:
        python:
          paths: [src]
          options:
            show_source: true
            show_bases: true
            members_order: source
            docstring_style: numpy
            docstring_section_style: spacy
            show_root_heading: true
            show_root_full_path: false
            merge_init_into_class: true
            show_signature_annotations: true
            separate_signature: true
  - glightbox

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.arithmatex:
      generic: true
  - attr_list
  - md_in_html
  - tables
  - toc:
      permalink: true
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - def_list
  - pymdownx.tasklist:
      custom_checkbox: true

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/Qalxry/LatticeSVG
    - icon: fontawesome/brands/python
      link: https://pypi.org/project/latticesvg/
  alternate:
    - name: English
      link: /LatticeSVG/
      lang: en
    - name: 简体中文
      link: /LatticeSVG/zh/
      lang: zh

extra_css:
  - assets/stylesheets/extra.css

extra_javascript:
  - javascripts/mathjax.js
  - https://unpkg.com/mathjax@3/es5/tex-mml-chtml.js

nav:
  - Home: index.md
  - Getting Started:
    - Installation: getting-started/installation.md
    - Quick Start: getting-started/quickstart.md
    - Core Concepts: getting-started/concepts.md
  - Tutorials:
    - Grid Layout: tutorials/grid-layout.md
    - Text & Typography: tutorials/text-typography.md
    - Node Types: tutorials/node-types.md
    - Styling & Visuals: tutorials/styling.md
    - Rich Text & Markup: tutorials/rich-text.md
    - Advanced Usage: tutorials/advanced.md
  - Reference:
    - CSS Properties: reference/css-properties.md
    - Built-in Templates: reference/templates.md
    - API Reference:
      - Overview: reference/api/index.md
      - Nodes: reference/api/nodes.md
      - Renderer: reference/api/renderer.md
      - Style System: reference/api/style.md
      - Text Engine: reference/api/text.md
      - Layout Engine: reference/api/layout.md
      - Markup Parser: reference/api/markup.md
      - Math: reference/api/math.md
  - Changelog: changelog.md