关于 docsify

优质
小牛编辑
123浏览
2023-12-01

关于 docsify

快速使用

npm i docsify-cli -g
  • 启动项目

进入项目根目录下,执行以下命令

npm run serve

当提示Listening at http://localhost:3000时,表示服务启动成功。

新增文档

__sidebar.md为导航栏,使用方法参考:loadsidebar

  • 让 IDE 的 markdown 编辑器支持上传图片

进入File - Settings - Plugins, 搜索markdown关键字, 安装 Paste Image into Markdown 插件

安装完成后重启 IDE, 再次编辑markdown文件时,截图后直接在 md 文件中粘贴,会弹出如下弹窗:

理论上只需要修改目录即可, 文件名都是随机值,最终文件上传生成 8 位随机多件名+后缀 png

部署文档

  • 原生部署(类似启动,然后使用 Nginx 代理即可)
  • Gitee Pages

上图两个地方使用默认配置即可

最后点击“更新”,等待大概 1 分钟,当出现已开启 Gitee Pages 服务,网站地址: http://innodev_group.gitee.io/innodev-doc则标识部署完成

参考

  • 本文档使用docsify搭建,详情请查阅官方文档。