初次配置时需要配置SSH-key和NodeJS
- 在
zxytql.top-Repo/
文件夹的根目录下执行终端- 运行
npm install
,执行安装命令。若要检查安装是否成功,可以运行npx docusaurus --version
,你应该能看到正确的版本输出- 现在运行
npm run start
,默认情况下,浏览器会自动打开 http://localhost:3000 的新窗口。代表环境配置完成,可以按照维护指南进行文档的修改操作了
-
添加新文档
- 修改
sidebars.js
中的mySidebar
- 在docs文件夹中放入写好的
.md
文件,将图片放入assets
中分文档放置,并修改.md
文件中链接的图片地址 - 在
zxy-website
根目录下试编译,运行npm run build
- 无报错,本地部署
npm run serve
查看效果 - 上传到 Github 进行自动部署
git status
git add .
git commit -m "xxxx"
git push -u origin master
- 修改
-
删除文档
仅需删除sidebar.js中的文档标签即可