Skip to content

Commit 0e769fe

Browse files
committed
docs(site): 重构多语言路由并添加章节索引页
将 VitePress 配置从根路径映射中文改为使用标准的 `/zh/` 和 `/en/` 路径结构,使多语言路由更清晰、更标准。 - 为每个文档章节(如核心概念、扩展开发等)创建了 `index.md` 索引页,作为该章节的概览和入口。 - 更新了侧边栏和导航栏的所有链接,以匹配新的多语言路径结构。 - 调整 `base` 路径为 `/comfytavern/` 以适应 GitHub Pages 部署。
1 parent 76c4bee commit 0e769fe

17 files changed

Lines changed: 254 additions & 95 deletions

File tree

docs-site/.vitepress/config.mjs

Lines changed: 138 additions & 95 deletions
Original file line numberDiff line numberDiff line change
@@ -1,131 +1,174 @@
1-
import { defineConfig } from 'vitepress'
1+
import { defineConfig } from "vitepress";
22

33
export default defineConfig({
44
title: "ComfyTavern 文档",
55
description: "一个面向创作者和最终用户的 AI 创作与应用平台。",
6-
7-
// 基础路径
8-
base: '/',
6+
base: "/comfytavern/",
7+
cleanUrls: true,
8+
lastUpdated: true,
99

10-
// 重写规则:将根路径映射到中文内容
11-
rewrites: {
12-
'zh/:rest*': ':rest*'
13-
},
14-
15-
// 主题配置
16-
themeConfig: {
17-
socialLinks: [
18-
{ icon: 'github', link: 'https://github.com/ComfyTavern/comfytavern' }
19-
],
20-
search: {
21-
provider: 'local'
22-
}
23-
},
24-
25-
// 多语言配置
2610
locales: {
27-
// 中文配置(默认语言,映射到根路径)
28-
root: {
29-
label: '简体中文',
30-
lang: 'zh',
31-
title: "ComfyTavern 文档",
32-
description: "一个面向创作者和最终用户的 AI 创作与应用平台。",
33-
11+
zh: {
12+
label: "简体中文",
13+
lang: "zh-CN",
14+
link: "/zh/",
3415
themeConfig: {
3516
nav: [
36-
{ text: '首页', link: '/' },
37-
{ text: '创作者指南', link: '/guide-for-creators/' },
38-
{ text: '开发者文档', link: '/developer-docs/core-concepts/workflow-concepts' }
17+
{ text: "首页", link: "/zh/" },
18+
{ text: "创作者指南", link: "/zh/guide-for-creators/" },
19+
{ text: "开发者文档", link: "/zh/developer-docs/" },
3920
],
4021
sidebar: {
41-
'/developer-docs/': [
22+
"/zh/developer-docs/": [
4223
{
43-
text: '核心概念',
24+
text: "核心概念",
4425
collapsed: false,
4526
items: [
46-
{ text: '工作流概念', link: '/developer-docs/core-concepts/workflow-concepts' },
47-
{ text: '节点与插槽类型系统', link: '/developer-docs/core-concepts/node-type-system' },
48-
]
27+
{ text: "概述", link: "/zh/developer-docs/core-concepts/" },
28+
{
29+
text: "工作流概念",
30+
link: "/zh/developer-docs/core-concepts/workflow-concepts",
31+
},
32+
{
33+
text: "节点与插槽类型系统",
34+
link: "/zh/developer-docs/core-concepts/node-type-system",
35+
},
36+
],
4937
},
5038
{
51-
text: '扩展开发',
39+
text: "扩展开发",
5240
collapsed: false,
5341
items: [
54-
{ text: '自定义节点开发', link: '/developer-docs/extension-dev/node-dev/custom-node-guide' },
55-
{ text: '客户端脚本指南', link: '/developer-docs/extension-dev/node-dev/client-script-guide' },
56-
{ text: '面板 SDK 开发', link: '/developer-docs/extension-dev/panel-dev/panel-sdk-guide' },
57-
{ text: '国际化', link: '/developer-docs/extension-dev/i18n/customizing-ui-language' },
58-
]
42+
{ text: "概述", link: "/zh/developer-docs/extension-dev/" },
43+
{
44+
text: "自定义节点开发",
45+
link: "/zh/developer-docs/extension-dev/node-dev/custom-node-guide",
46+
},
47+
{
48+
text: "客户端脚本指南",
49+
link: "/zh/developer-docs/extension-dev/node-dev/client-script-guide",
50+
},
51+
{
52+
text: "面板 SDK 开发",
53+
link: "/zh/developer-docs/extension-dev/panel-dev/panel-sdk-guide",
54+
},
55+
{
56+
text: "国际化",
57+
link: "/zh/developer-docs/extension-dev/i18n/customizing-ui-language",
58+
},
59+
],
5960
},
6061
{
61-
text: '源码与架构解析',
62-
collapsed: false,
63-
items: [
64-
{ text: '前端内容与风格指南', link: '/developer-docs/architecture/frontend-style-guide' },
65-
{ text: '历史记录系统', link: '/developer-docs/architecture/history-system' },
66-
{ text: '文件与资产管理', link: '/developer-docs/architecture/file-asset-management' },
67-
]
68-
}
69-
]
62+
text: "源码与架构解析",
63+
collapsed: false,
64+
items: [
65+
{ text: "概述", link: "/zh/developer-docs/architecture/" },
66+
{
67+
text: "前端内容与风格指南",
68+
link: "/zh/developer-docs/architecture/frontend-style-guide",
69+
},
70+
{
71+
text: "历史记录系统",
72+
link: "/zh/developer-docs/architecture/history-system",
73+
},
74+
{
75+
text: "文件与资产管理",
76+
link: "/zh/developer-docs/architecture/file-asset-management",
77+
},
78+
],
79+
},
80+
],
7081
},
71-
selectLanguageText: '选择语言',
72-
selectLanguageName: '简体中文',
73-
lastUpdatedText: '最后更新时间',
74-
editLinkText: '在 GitHub 上编辑此页',
75-
outlineTitle: '本页目录'
76-
}
82+
lastUpdatedText: "最后更新",
83+
docFooter: {
84+
prev: "上一页",
85+
next: "下一页",
86+
},
87+
outlineTitle: "本页目录",
88+
},
7789
},
78-
// 英文配置
7990
en: {
80-
label: 'English',
81-
lang: 'en',
82-
link: '/en/',
83-
title: "ComfyTavern Docs",
84-
description: "An AI creation and application platform for creators and end-users.",
85-
91+
label: "English",
92+
lang: "en-US",
93+
link: "/en/",
8694
themeConfig: {
8795
nav: [
88-
{ text: 'Home', link: '/en/' },
89-
{ text: 'Creator Guides', link: '/en/guide-for-creators/' },
90-
{ text: 'Developer Docs', link: '/en/developer-docs/core-concepts/workflow-concepts' }
96+
{ text: "Home", link: "/en/" },
97+
{ text: "Creator Guides", link: "/en/guide-for-creators/" },
98+
{ text: "Developer Docs", link: "/en/developer-docs/" },
9199
],
92100
sidebar: {
93-
'/en/developer-docs/': [
101+
"/en/developer-docs/": [
94102
{
95-
text: 'Core Concepts',
103+
text: "Core Concepts",
96104
collapsed: false,
97105
items: [
98-
{ text: 'Workflow Concepts', link: '/en/developer-docs/core-concepts/workflow-concepts' },
99-
{ text: 'Node and Slot Type System', link: '/en/developer-docs/core-concepts/node-type-system' },
100-
]
106+
{ text: "Overview", link: "/en/developer-docs/core-concepts/" },
107+
{
108+
text: "Workflow Concepts",
109+
link: "/en/developer-docs/core-concepts/workflow-concepts",
110+
},
111+
{
112+
text: "Node and Slot Type System",
113+
link: "/en/developer-docs/core-concepts/node-type-system",
114+
},
115+
],
101116
},
102117
{
103-
text: 'Extension Development',
118+
text: "Extension Development",
104119
collapsed: false,
105120
items: [
106-
{ text: 'Custom Node Development', link: '/en/developer-docs/extension-dev/node-dev/custom-node-guide' },
107-
{ text: 'Client Script Guide', link: '/en/developer-docs/extension-dev/node-dev/client-script-guide' },
108-
{ text: 'Panel SDK Development', link: '/en/developer-docs/extension-dev/panel-dev/panel-sdk-guide' },
109-
{ text: 'Internationalization', link: '/en/developer-docs/extension-dev/i18n/customizing-ui-language' },
110-
]
121+
{ text: "Overview", link: "/en/developer-docs/extension-dev/" },
122+
{
123+
text: "Custom Node Development",
124+
link: "/en/developer-docs/extension-dev/node-dev/custom-node-guide",
125+
},
126+
{
127+
text: "Client Script Guide",
128+
link: "/en/developer-docs/extension-dev/node-dev/client-script-guide",
129+
},
130+
{
131+
text: "Panel SDK Development",
132+
link: "/en/developer-docs/extension-dev/panel-dev/panel-sdk-guide",
133+
},
134+
{
135+
text: "Internationalization",
136+
link: "/en/developer-docs/extension-dev/i18n/customizing-ui-language",
137+
},
138+
],
111139
},
112140
{
113-
text: 'Source Code & Architecture Analysis',
114-
collapsed: false,
115-
items: [
116-
{ text: 'Frontend Content & Style Guide', link: '/en/developer-docs/architecture/frontend-style-guide' },
117-
{ text: 'History System', link: '/en/developer-docs/architecture/history-system' },
118-
{ text: 'File & Asset Management', link: '/en/developer-docs/architecture/file-asset-management' },
119-
]
120-
}
121-
]
141+
text: "Source Code & Architecture Analysis",
142+
collapsed: false,
143+
items: [
144+
{ text: "Overview", link: "/en/developer-docs/architecture/" },
145+
{
146+
text: "Frontend Content & Style Guide",
147+
link: "/en/developer-docs/architecture/frontend-style-guide",
148+
},
149+
{ text: "History System", link: "/en/developer-docs/architecture/history-system" },
150+
{
151+
text: "File & Asset Management",
152+
link: "/en/developer-docs/architecture/file-asset-management",
153+
},
154+
],
155+
},
156+
],
122157
},
123-
selectLanguageText: 'Languages',
124-
selectLanguageName: 'English',
125-
lastUpdatedText: 'Last Updated',
126-
editLinkText: 'Edit this page on GitHub',
127-
outlineTitle: 'On this page'
128-
}
129-
}
130-
}
131-
})
158+
lastUpdatedText: "Last Updated",
159+
docFooter: {
160+
prev: "Previous page",
161+
next: "Next page",
162+
},
163+
outlineTitle: "On this page",
164+
},
165+
},
166+
},
167+
168+
themeConfig: {
169+
socialLinks: [{ icon: "github", link: "https://github.com/ComfyTavern/comfytavern" }],
170+
search: {
171+
provider: "local",
172+
},
173+
},
174+
});
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Architecture Overview
2+
3+
Welcome to the architecture section. Here you'll find detailed explanations of ComfyTavern's internal workings, design principles, and core systems.
4+
5+
## Key Topics
6+
7+
- **[Frontend Content & Style Guide](./frontend-style-guide.md)**: Learn about our frontend development standards, including coding style, component structure, and UI/UX guidelines.
8+
- **[History System](./history-system.md)**: An in-depth look at how we manage and track workflow execution history for reproducibility and debugging.
9+
- **[File & Asset Management](./file-asset-management.md)**: Understand the mechanisms for handling files, uploads, and other assets within the platform.
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Core Concepts
2+
3+
This section introduces the fundamental concepts that form the foundation of ComfyTavern. Understanding these is crucial for both using and developing on the platform.
4+
5+
## Key Topics
6+
7+
- **[Workflow Concepts](./workflow-concepts.md)**: Dive into how workflows are structured, executed, and managed.
8+
- **[Node and Slot Type System](./node-type-system.md)**: Explore the powerful type system that governs how nodes connect and exchange data.
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Internationalization (i18n)
2+
3+
This section provides a comprehensive guide to adding multi-language support to your ComfyTavern extensions.
4+
5+
- **[Customizing UI Language](./customizing-ui-language.md)**: Learn the best practices for managing translation files and implementing language switching in your custom nodes and panels.
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Extension Development
2+
3+
ComfyTavern is designed to be extensible. This section provides all the information you need to build your own custom extensions, from nodes to UI panels.
4+
5+
## Key Areas
6+
7+
- **[Node Development](./node-dev/)**: Guides and references for creating your own custom nodes.
8+
- **[Panel Development](./panel-dev/)**: Learn how to build custom UI panels using our SDK.
9+
- **[Internationalization (i18n)](./i18n/)**: Instructions on how to make your extensions available in multiple languages.
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Node Development
2+
3+
Dive into the world of custom node creation. These guides cover everything from basic node structure to advanced client-side scripting.
4+
5+
- **[Custom Node Guide](./custom-node-guide.md)**: A step-by-step tutorial on building your first custom node.
6+
- **[Client Script Guide](./client-script-guide.md)**: Learn how to add interactive client-side logic to your nodes.
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Panel Development
2+
3+
Unlock the full potential of ComfyTavern by creating custom application panels.
4+
5+
- **[Panel SDK Guide](./panel-sdk-guide.md)**: Your starting point for understanding the Panel SDK and building your own interactive UI panels.
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# Developer Documentation
2+
3+
Welcome to the ComfyTavern developer documentation. Whether you're looking to understand the core architecture, develop custom extensions, or contribute to the project, you'll find the necessary resources here.
4+
5+
## Main Sections
6+
7+
- **[Core Concepts](./core-concepts/)**: Start here to understand the fundamental principles of ComfyTavern.
8+
- **[Extension Development](./extension-dev/)**: Learn how to build custom nodes, panels, and more.
9+
- **[Architecture](./architecture/)**: A deep dive into the internal systems and design of the platform.
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Guide for Creators
2+
3+
Welcome, creators! This section is dedicated to helping you master the art of building powerful and creative workflows in ComfyTavern.
4+
5+
Whether you are new to node-based creation or an experienced professional, these guides will provide you with the knowledge to bring your ideas to life.
6+
7+
*(More guides and tutorials will be added soon.)*
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# 架构概览
2+
3+
欢迎来到架构部分。在这里,您将找到关于 ComfyTavern 内部工作原理、设计原则和核心系统的详细说明。
4+
5+
## 核心主题
6+
7+
- **[前端内容与风格指南](./frontend-style-guide.md)**: 了解我们的前端开发标准,包括编码风格、组件结构和 UI/UX 指导原则。
8+
- **[历史记录系统](./history-system.md)**: 深入了解我们如何管理和跟踪工作流执行历史,以实现可复现性和调试。
9+
- **[文件与资产管理](./file-asset-management.md)**: 理解在平台内处理文件、上传和其他资产的机制。

0 commit comments

Comments
 (0)