springboot 集成 docsify 实现随身文档

2022-09-09 00:00:00 文档 支持 部署 工具 访问

需求分析

  • 文档可以和项目一起进行版本管理
  • 文档可以在线访问
  • 文档可以与springboot项目集成，不需要分开部署
  • MarkDown支持
  • 文档跟随，打包jar也可以访问

技术选型

对于网上已有的方案，大致分为如下几种

  1. 将文档部署在 resource静态资源目录下，用模板渲染访问。[1]
  2. 分离部署，打包 jar后还需要单独上传静态资源文档内容并部署。

终选定的技术方案如下

工具用途官网
Typora文档编写https://typoraio.cn/
Docsify文档部署https://docsify.js.org/#/
Hutool服务集成https://www.hutool.cn/docs/#/

相关文章