Dubbo 生成文档,导出 Markdown,这些功能 DocView 现在都有了!

2020-11-23 12:10:07 浏览数 (1)

前言

" 自从 DocView 发布了简陋的第一版之后,就不断地有小伙伴提建议意见等等,希望扩展各种功能。这不,时隔两周,DocView 又发布了新版本,本次的更新主要涉及到支持 Dubbo,以及支持导出单个文档为 Markdown 文件。来一起看看新功能吧! "

支持导出 Markdown 文件

DocView 原版本已经支持复制到剪贴板的功能。

原版本

而在新版本中增加了 Export 按钮,可以将单个文档导出为 Markdown 文件。

新版本

来一张动图,大家看看效果:

导出的 Markdown 文本内容如下:

支持 Dubbo 接口

之前的版本是不支持 Dubbo 接口的,而现在的版本可以在 Dubbo 接口里面使用。

当然这里并没有校验接口是否为 Dubbo 接口,只是校验了下是否为接口。所以说即使其他接口也是可以生成的。

这块还是需要完善的!

DocView 文档地址

在面板左下角的 help 按钮修改了跳转地址为:http://docview.liuzhihang.com/

只是粗略搭建了一个 DocView 的说明文档网站,小伙伴们可以发现这个网站连 logo 都没有。

其他

当然也有一些其他的小改动,比如设置页面(依然不支持自定义设置)。

总结

DocView 虽然支持了一部分功能,但是距离小伙伴们期望中的文档插件还有很多很多需要迭代的功能。

比如:

  • 批量生成(当前仅支持单个类或者方法)
  • 批量导出
  • 面板支持查看 Markdown 源文本
  • 支持从 Swagger 注解获取字段相关信息
  • 支持 Setting 设置
  • 支持自定义模版
  • 支持上传的 YApi
  • 支持导出其他类型
  • ...

嗯~ 可能大概也许应该会需要迭代很久……

也确实是个人能力和精力有限,如果小伙伴们有兴趣,可以提交 PR。

当然如果小伙伴们发现一些 bug 或者有好的意见建议,也可以留言指出来。

留言推荐大家在 GitHub 提 Issues

最后如果小伙伴们觉得插件不错,可以推荐给周围的朋友同事,也记得 一键三连, 来个 【分享、点赞、再看】

- <End /> -

0 人点赞