Documents for KubeSphere.
If you choose this way, we recommend you to install some requisites
- git
- node.js
- yarn (or npm,
we recommend yarn)
Check your requisites:
git --version
node -v
yarn -vThen you are ready to go:
git clone https://github.com/kubesphere/docs.kubesphere.io.git
cd docs.kubesphere.io
yarn
yarn developTree of repo:
├── content // documents directory
│ ├── express // documents version
│ │ ├── en // documents language
│ │ │ └── KubeSphere-Installer-Guide.md // document
│ │ └── zh-CN
│ │ └── KubeSphere-Installer-Guide.md
│ ├── toc_express_en.json // table of contents, define the page navigation
│ └── toc_express_zh-CN.json
├── src
└── static // put document images here
└── daemonset_create_1.pngIf you want to edit the document, you can follow the ways below:
- Create a new directory called the new version name under the
contentdirectory
cd content && mkdir version-xxxx- Create subdirectories for each language you want to support
cd content/version-xxxx && mkdir zh-CN en- Create navigation files for each language of the new version under the
contentdirectory
cd content
touch toc_version-xxx_en.json toc_version-xxx_zh-CN.jsonnavigation file example
- id: should match the format of
{version}-{language} - chapters: nav items
- title: nav title
- entry: nav entry, path to the document to display
- entries: sub navs
{
"id": "express-zh-CN",
"chapters": [
{
"title": "简介",
"entry": "./express/zh-CN/basic.md"
},
{
"title": "应用负载",
"entries": [
{
"entry": "./express/zh-CN/manage-deployments.md"
},
{
"entry": "./express/zh-CN/manage-statefulsets.md"
},
{
"entry": "./express/zh-CN/manage-daemonsets.md"
}
],
"chapters": [
]
}
]
}document example
---
title: 'document title, will show in nav'
---
## title 1
content 1
this path will request ``/static/image.png``
## title 2
### subtitle 2.1
content 2.1
### title 3
## will be transformed to an anchor of the page, and will show in the nav.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent