返回 Pixelle-Video
mkdocs.yml
根目录 / mkdocs.yml
1 site_name: Pixelle-Video
2 site_description: AI Video Creator - Generate a short video in 3 minutes
3 site_author: Pixelle.AI
4 site_url: https://AIDC-AI.github.io/Pixelle-Video/
5
6 repo_name: AIDC-AI/Pixelle-Video
7 repo_url: https://github.com/AIDC-AI/Pixelle-Video
8 edit_uri: edit/main/docs/
9
10 copyright: Copyright © 2025 Pixelle.AI
11
12 theme:
13 name: material
14 language: en
15 palette:
16 # Light mode
17 - media: "(prefers-color-scheme: light)"
18 scheme: default
19 primary: indigo
20 accent: indigo
21 toggle:
22 icon: material/brightness-7
23 name: Switch to dark mode
24 # Dark mode
25 - media: "(prefers-color-scheme: dark)"
26 scheme: slate
27 primary: indigo
28 accent: indigo
29 toggle:
30 icon: material/brightness-4
31 name: Switch to light mode
32
33 font:
34 text: Roboto
35 code: Roboto Mono
36
37 features:
38 - navigation.instant # Instant loading
39 - navigation.tracking # Anchor tracking
40 - navigation.tabs # Top-level tabs
41 - navigation.tabs.sticky # Sticky tabs
42 - navigation.sections # Sidebar sections
43 - navigation.expand # Expand sections
44 - navigation.top # Back to top button
45 - navigation.footer # Footer navigation
46 - search.suggest # Search suggestions
47 - search.highlight # Search highlighting
48 - search.share # Share search results
49 - content.code.copy # Copy button for code blocks
50 - content.code.annotate # Code annotations
51 - content.tabs.link # Link content tabs
52
53 icon:
54 repo: fontawesome/brands/github
55
56 plugins:
57 - search:
58 lang:
59 - en
60 - zh
61 - i18n:
62 docs_structure: folder
63 languages:
64 - locale: en
65 default: true
66 name: English
67 build: true
68 - locale: zh
69 name: 中文
70 build: true
71 nav_translations:
72 Home: 首页
73 Getting Started: 快速开始
74 Installation: 安装
75 Quick Start: 快速入门
76 Configuration: 配置
77 User Guide: 用户指南
78 Web UI: Web 界面
79 API Usage: API 使用
80 Workflows: 工作流定制
81 Templates: 模板开发
82 Gallery: 示例库
83 Tutorials: 教程
84 Your First Video: 生成你的第一个视频
85 Custom Style: 自定义视觉风格
86 Voice Cloning: 声音克隆
87 Reference: 参考
88 API Overview: API 概览
89 Config Schema: 配置文件详解
90 Development: 开发指南
91 Architecture: 架构设计
92 Contributing: 贡献指南
93 FAQ: 常见问题
94 Troubleshooting: 故障排查
95 - git-revision-date-localized:
96 enable_creation_date: true
97 type: datetime
98
99 markdown_extensions:
100 # Python Markdown
101 - abbr
102 - admonition
103 - attr_list
104 - def_list
105 - footnotes
106 - md_in_html
107 - toc:
108 permalink: true
109
110 # Python Markdown Extensions
111 - pymdownx.arithmatex:
112 generic: true
113 - pymdownx.betterem:
114 smart_enable: all
115 - pymdownx.caret
116 - pymdownx.details
117 - pymdownx.emoji:
118 emoji_index: !!python/name:material.extensions.emoji.twemoji
119 emoji_generator: !!python/name:material.extensions.emoji.to_svg
120 - pymdownx.highlight:
121 anchor_linenums: true
122 line_spans: __span
123 pygments_lang_class: true
124 - pymdownx.inlinehilite
125 - pymdownx.keys
126 - pymdownx.mark
127 - pymdownx.smartsymbols
128 - pymdownx.superfences:
129 custom_fences:
130 - name: mermaid
131 class: mermaid
132 format: !!python/name:pymdownx.superfences.fence_code_format
133 - pymdownx.tabbed:
134 alternate_style: true
135 - pymdownx.tasklist:
136 custom_checkbox: true
137 - pymdownx.tilde
138
139 nav:
140 - Home: index.md
141 - Getting Started:
142 - Installation: getting-started/installation.md
143 - Quick Start: getting-started/quick-start.md
144 - Configuration: getting-started/configuration.md
145 - User Guide:
146 - Web UI: user-guide/web-ui.md
147 - API Usage: user-guide/api.md
148 - Workflows: user-guide/workflows.md
149 - Templates: user-guide/templates.md
150 - Gallery: gallery/index.md
151 - Tutorials:
152 - Your First Video: tutorials/your-first-video.md
153 - Custom Style: tutorials/custom-style.md
154 - Voice Cloning: tutorials/voice-cloning.md
155 - Reference:
156 - API Overview: reference/api-overview.md
157 - Config Schema: reference/config-schema.md
158 - Development:
159 - Architecture: development/architecture.md
160 - Contributing: development/contributing.md
161 - FAQ: faq.md
162 - Troubleshooting: troubleshooting.md
163
164 extra:
165 social:
166 - icon: fontawesome/brands/github
167 link: https://github.com/AIDC-AI/Pixelle-Video
168 name: GitHub Repository
169
170 extra_css:
171 - stylesheets/extra.css
172
172 lines YAML