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.
 
 
 
 
 
 
ethanzheng 06908a048a update install script 5 days ago
blog 迁移代码 3 weeks ago
docs add deploy faq 1 week ago
install update install script 5 days ago
src 迁移代码 3 weeks ago
static 迁移代码 3 weeks ago
.drone.yml 更新 '.drone.yml' 3 weeks ago
.gitignore 迁移代码 3 weeks ago
.gitlab-ci.yml 迁移代码 3 weeks ago
.npmrc feat:更换镜像源 2 weeks ago
README.md 更新 'README.md' 3 weeks ago
babel.config.js 迁移代码 3 weeks ago
deploy.yaml 迁移代码 (#1) 3 weeks ago
dockerfile 迁移代码 (#1) 3 weeks ago
docusaurus.config.js 迁移代码 3 weeks ago
nginx.conf 迁移代码 (#1) 3 weeks ago
package-lock.json 迁移代码 3 weeks ago
package.json 迁移代码 3 weeks ago
sidebars.js 迁移代码 3 weeks 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 Markdown Nginx other