You can not select more than 25 topics
Topics must start with a chinese character,a letter or number, can include dashes ('-') and can be up to 35 characters long.
linfengjun
50b289e256
|
1 month ago | |
|---|---|---|
| docs | 4 months ago | |
| src | 9 months ago | |
| static | 2 years ago | |
| .drone.yml | 1 year ago | |
| .gitignore | 3 years ago | |
| .gitlab-ci.yml | 3 years ago | |
| .npmrc | 1 year ago | |
| README.md | 3 years ago | |
| babel.config.js | 3 years ago | |
| deploy.yaml | 1 month ago | |
| dockerfile | 1 year ago | |
| docusaurus.config.js | 10 months ago | |
| nginx.conf | 1 year ago | |
| package-lock.json | 1 year ago | |
| package.json | 1 year ago | |
| sidebars.js | 3 years ago | |
README.md
Octopus Doc
所有文档在docs目录中，使用Markdown格式撰写。侧边栏文档目录请在sidebars.js中进行配置。
master分支更新将自动触发构建并部署。
文档编辑格式和高级用法请参考Docusaurus文档。
运行在本地服务器
环境
-
Node.js 版本 >= 12.13.0（您可使用 node -v 查看版本）。 您可以使用 nvm 来管理主机上的多个 Node 版本
-
使用npm淘宝镜像
npm install -g cnpm --registry=https://registry.npm.taobao.org
- 安装依赖
进入项目目录
cnpm install
- 运行
cnpm start -- --locale zh
部署
构建静态文件到build目录下
cnpm run build
多版本
- 创建版本
cnpm run docusaurus docs:version 版本号
Markdown用法
参考 https://www.docusaurus.cn/docs/markdown-features
octopus-doc
SVG JavaScript CSS Nginx
