rcpress icon indicating copy to clipboard operation
rcpress copied to clipboard

大佬,是否可以部署到 github gitlab pages ,根据 github gitlab 的 api 自动获取 issue 生成文档列表

Open WangShuXian6 opened this issue 6 years ago • 2 comments

前置

AntdSite 非常适合生成文档

当前的文档生成器 UI 都比较简约【简单】【没有专门的配套 UI 库】

根据 md 文件自动生成 文档,无需借助服务端的 docsify docsify 是一个动态生成文档网站的工具。不同于 GitBook、Hexo 的地方是它不会生成将 .md 转成 .html 文件,所有转换工作都是在运行时进行。 可以直接部署在 GitHub Pages 但是需要自己生成 md,并且样式比较简约,无法同步 issues,或 wiki,需要手动复制一份 github 和 gitlab 的 issues 和 wiki 作为项目文档应用非常广泛

根据 issues 自动生成博客 https://segmentfault.com/a/1190000019265122 https://jrainlau.github.io/#/ 源码 使用 Github issues 作为博客平台,也就是相当于管理后端。在管理后端里面撰写文章,设置标签,回复评论,然后通过 API 调用把数据传送给客户端。 但是样式只适合博客,不适合文档展示,只能基于 issues,不能基于 wiki 生成文档

需求分析

是否可以提供以下功能

  • [x] 类似 docsify 根据 md 文件自动生成文档,编译一次,只为生成文档模版,运行时自动生成文档
  • [x] 根据以上的功能进一步智能化,通过 github api ,gitlab api 自动 获取 关联仓库的 issues 或 wiki ,运行时自动生成文档
  • [x] 最终只需部署到 github page,gitlab page 上即可在线查看文档

WangShuXian6 avatar Aug 08 '19 10:08 WangShuXian6

这个相当于增加一个blog主题了,实现起来并不简单,可以列入未来的规划里。

wangyi7099 avatar Aug 08 '19 11:08 wangyi7099

github好像不支持获取wiki的api 所以好像有点坑了。。

wangyi7099 avatar Aug 30 '19 11:08 wangyi7099