Skip to content

Latest commit

 

History

History
48 lines (29 loc) · 2.87 KB

README_ZH.md

File metadata and controls

48 lines (29 loc) · 2.87 KB

English | 中文

Kosmos 文档与网站

这个仓库包含了KubeNest 网站的源代码以及所有的 KubeNest 文档。 它是由Docusaurus构建的,一个现代的静态网站生成器。

欢迎加入我们,非常感谢您的贡献!

添加或更新文档

当您添加或修改文档时,应该考虑这两个文件夹(docs/i18n/zh-Hans/docusaurus-plugin-content-docs/current)。

使用 Node.js 运行

如果您有 Node.js 环境,可以在本地运行该网站。

  • 推荐使用 Node.js v18.0.0+ 和 npm v8.6+
  • 您可以下载 Node.js
# 克隆仓库,或克隆您自己的分叉
git clone https://github.com/<YOUR_GITHUB_USERNAME>/website.git

# 构建
yarn

# 启动网站
yarn start

一旦网站在本地运行,您可以通过访问 http://localhost:3000/ 预览网站。

如何提交文档到这个仓库

该项目的默认文档语言是英语。

  • 英文文档提交路径:./docs
  • 中文文档提交路径:./i18n/zh-Hans/docusaurus-plugin-content-docs/current

注意:中文和英文文档的目录结构必须完全相同。

发送您的拉取请求

在检查所有更改后,请创建一个拉取请求并附上DCO