[](https://github.com/apache/incubator-seata-website/actions )
此仓库包含 https://seata.apache.org 的所有网站材料,使用的开源框架是 Docusaurus。
npm install
npm run start
用于在本地上启动 Seata 的 英文 网站。
npm run start-zh-cn
用于在本地上启动 Seata 的 中文 网站。
Visit
localhost:3000/
npm run build
npm run serve
Visit
localhost:3000/
Base docusaurus 2.4.1
Node.js version 19.5.0
请注意,如果您使用 npm run start-zh-cn
或 npm run start
以开发模式启动网站,语言切换功能将不起作用。请使用构建过程在生产模式下运行网站,以启用语言切换功能。
我们使用 Docusaurus 国际化 (i18n) 来支持英语 (en) 和简体中文 (zh-cn) 两种语言的 Seata 网站。此外,我们还使用 Docusaurus 多版本,对文档划分了版本。
版本化和国际化文档网站结构如下所示:
website ├── sidebars.json # 当前文档版本的侧边栏 ├── docs # 当前文档版本的文档目录 │ ├── foo │ │ └── bar.md # https://mysite.com/docs/next/foo/bar │ └── hello.md # https://mysite.com/docs/next/hello ├── versions.json # 表明哪些版本可用的文件 ├── versioned_docs │ ├── version-1.1.0 │ │ ├── foo │ │ │ └── bar.md # https://mysite.com/docs/foo/bar │ │ └── hello.md │ └── version-1.0.0 │ ├── foo │ │ └── bar.md # https://mysite.com/docs/1.0.0/foo/bar │ └── hello.md ├── versioned_sidebars │ ├── version-1.1.0-sidebars.json │ └── version-1.0.0-sidebars.json ├── blog ├── docusaurus.config.js ├── package.json ├── i18n │ ├── en │ │ ├── docusaurus-plugin-content-docs │ │ │ ├── current │ │ │ ├── version-1.0.0 │ │ │ └── version-1.1.0 │ │ ├── docusaurus-plugin-content-blog │ │ └── ... │ └── zh-cn │ │ ├── docusaurus-plugin-content-docs │ │ │ ├── current │ │ │ ├── version-1.0.0 │ │ │ └── version-1.1.0 │ │ ├── docusaurus-plugin-content-blog │ │ └── ...
docs - 放置 current(最新版)文档 (仅作占位,为了让 sidebar 索引到)
文档中内容:Placeholder. DO NOT DELETE.
sidebars.json - 设置 current(最新版)侧边栏
versioned_docs - 放置之前版本文档 (仅作占位,为了让 sidebar 索引到)
文档中内容:Placeholder. DO NOT DELETE.
versioned_sidebars - 设置 之前版本侧边栏
i18-en
-docusaurus-plugin-content-docs-current
- 放置最新版 英文文档 (实际文档)
i18-en
-docusaurus-plugin-content-docs-version-1.0.0
- 放置1.0.0版 英文文档 (实际文档)
i18-zh-cn
-docusaurus-plugin-content-docs-current
- 放置最新版 中文文档 (实际文档)
i18-zh-cn
-docusaurus-plugin-content-docs-version-1.0.0
- 放置1.0.0版 中文文档 (实际文档)
新增最新版文档的步骤:
en
-docusaurus-plugin-content-docs-current
-路径 放置英文文档zh-cn
-docusaurus-plugin-content-docs-current
-路径 放置中文文档新增之前某版本文档的步骤:
en
-docusaurus-plugin-content-docs-某版本号
-路径 放置英文文档zh-cn
-docusaurus-plugin-content-docs-某版本号
-路径 放置中文文档注意:相同内容的对应中/英文文件,且中/英文文件名要一致。
我们没有分版本的博客,因此添加博客更为方便。添加新博客时,会自动添加到博客侧栏中,其中博客的顺序按博客文件中 SEO 中的“日期”字段自动排序。
blog - 放置所有博客 (仅作占位,为了让博客的 sidebar 索引到)
文档中内容:Placeholder. DO NOT DELETE.
i18-en
-docusaurus-plugin-content-blog - 放置所有的英文博客 (实际博客)
i18-zh-cn
-docusaurus-plugin-content-blog - 放置所有的中文博客 (实际博客)
新增博客的步骤:
en
-docusaurus-plugin-content-blog 放置英文博客zh-cn
-docusaurus-plugin-content-blog 放置中文博客注意:相同内容的对应中/英文文件,且中/英文文件名要一致。
md 文件开头的格式为:
--- title: title keywords: [keywords1,keywords2] description: some description author: author name date: 2018-12-29 custom_edit_url: https://github.com/apache/incubator-seata-website/blob/docusaurus/i18n/en/docusaurus-plugin-content-blog/download.md ---
注意:
<img>、<br>
,将其替换为<img /> <br />
<xx>
,请替换为<xx>