可能是国内颜值最高的开源文档工具?

2023-06-28 09:26:31 +08:00
 star7th

地址

开源地址: https://github.com/star7th/showdoc

官网: https://www.showdoc.com.cn/

开发小故事

早前,showdoc 发布过 3.0 UI 重构版,但是尚未完全达到设计预期,属于略微仓促发布的版本。在那个时候,设计师委婉地说过,他习惯一步到位,做完善产品了再上线。意思是想我更完善 showdoc 再发布。

我跟他就这个观点进行了交流,还蛮有意思的。这是两种风格迥异的产品思维。一种是把产品打磨得很好,一出场就惊艳用户。一种是小步快走,分阶段迭代。实际上,我也看过设计师的其他作品,确实给人的第一感觉就很惊艳,其产品给目标用户的第一印象非常好。

对于 showdoc 项目而言,我要照顾到开发时间成本和宣发机会,我比较愿意追求留给用户一种 “这个产品一直在优化在进步”的印象,而不需花太长的时间“憋大招”来惊艳用户。

于是在 3.0 版发布了一段时间后的今天,3.2 完全版也出来了。本轮更新,在设计师的“像素眼”注视下,修改了大量细节,优化了很多视觉 UI 和交互体验。

3.2 版本更新了什么

相关截图

给新用户看的 showdoc 介绍

ShowDoc 是一个非常适合 IT 团队的在线 API 文档、技术文档工具,既有开箱即用的在线托管服务版,也有免费的开源版( github 1 万+ star )。通过 showdoc ,你可以方便地使用 markdown 语法来书写出美观的 API 文档、数据字典文档、技术文档、在线 excel 文档等等。如果不想编辑 markdown 文档,你还可以利用 showdoc 的自动化能力,从程序注释中自动生成 API 文档,或者从搭配的 RunApi 客户端(类似 postman 的 api 调试工具)中一边调试接口、一边自动生成文档。无需手动编写文档,释放生产力。通过分配项目成员和团队成员,你可以很方便地进行项目文档的权限管理和团队协作,也可以分享文档出去给朋友查看。ShowDoc 还支持多平台客户端,有 win 客户端、mac 客户端、ios 、android 等,更方便跨平台使用。目前超过 100000+的互联网团队正在使用 showdoc ,包括知名公司内部的一些团队,比如腾讯、华为、百度、京东、字节跳动等等。

关于 Showdoc 的详细介绍,请看: https://www.showdoc.com.cn/help

18388 次点击
所在节点    分享创造
234 条回复
wu00
2023-06-28 10:02:50 +08:00
优势是私有化部署很方便;
另外 html 代码必须压缩,否则标签之间的换行会导致解析成<br/>
比如:
<table>
<td>
xxx
</td>
</table>
这个解析出来一堆 br
xiaoz
2023-06-28 10:02:56 +08:00
用了 showdoc 一段时间了,首先表示感谢。

看了下新版,感觉变化不大啊。另外语雀的文档我觉得还挺好看的,但不支持私有部署。
yhxx
2023-06-28 10:06:10 +08:00
确实不是很好看。。。

楼主想要反例的话,我来举一个栗子吧
yhxx
2023-06-28 10:06:29 +08:00
https://github.com/antvis/gatsby-theme-antv
不小心按错发出去了
antv 应该算是国内的吧
star7th
2023-06-28 10:07:02 +08:00
@whyzp2019

我同意你的说法,审美是很主观的。
不过我没有跟别人顶,是别人跟我顶。目前我说的话,发布的文字,基本符合事实,没有脱离事实的夸大。
swulling
2023-06-28 10:07:46 +08:00
看了下示例文档,感觉也不是很讲究。对前端设计不熟,就以你们的官方文档页面( https://www.showdoc.com.cn/help/1385767280275683 ) 为例,说说文档的内容存在的问题吧:

1. 「 ShowDoc 部署手册请参考」:中英文混排时没有在英文和中文间留白(不管你是 CSS 控制还是手动增加空格的方式),造成阅读上感觉很拥挤。
2. Markdown 格式的文档,存在大量的直接超链接,比如:「如果你没有自己的服务器,但又想使用 ShowDoc 作为文档分享工具,你可以使用在线的 ShowDoc http://www.showdoc.com.cn 」。
3. 「 showdoc 支持网页版、手机 app 版和电脑客户端版。」:关键英文名词时而大写 ShowDoc ,时而小写 showdoc 。
4. Markdown 中的代码,在复制的时候,每一行开头都增加了空格。


至于外在颜值我也觉得也比较一般。
star7th
2023-06-28 10:08:06 +08:00
@wu00

markdown 编辑器会把换行符翻译为换行,所以输入 html 标签的时候,标签与标签之间不要包含换行,会被转义为 br 换行或者 p 段落。
Jynxio
2023-06-28 10:09:08 +08:00
1.我赞同 @ggp1ot2 和 @vayci 的观点,我也认为 showdoc 的审美很平庸,它不可能是「国内颜值最高的 XXX 」
star7th
2023-06-28 10:10:11 +08:00
@yhxx

好像跟 showdoc 不是同一类的产品。不过确实看起来不错。我可以参考下
seth19960929
2023-06-28 10:10:40 +08:00
@star7th 我并没有说不写 API 文档, 我指的是用 showdoc. 为什么不用 yapi, apifox 之类的工具呢. showdoc 又不能发送请求. mock 数据, 接口测试. 光看?
star7th
2023-06-28 10:11:06 +08:00
@swulling

非常感谢你这样有理有据的反馈。我根据你说的内容优化下。
star7th
2023-06-28 10:12:30 +08:00
@seth19960929

runapi 能发送请求能 mock 数据和接口测试,并且自动生成文档到 showdoc https://www.showdoc.com.cn/runapi

showdoc 的定位是 文档 。你说的这些需求,用 runapi 都能满足。
shuxhan
2023-06-28 10:12:33 +08:00
个人感觉 https://vitepress.dev/guide/what-is-vitepress 颜值更耐打,细节方面处理的比较好
op 的这个虽然小清新,但是总感觉怪怪的
比如主体部分的阴影就很生硬,并且在跳转的时候没发现侧栏会闪动吗,这个属实不应该,可以优化一下
包括字体大小和颜色方面可以好好琢磨一下,还有很大的优化空间
whyzp2019
2023-06-28 10:13:44 +08:00
@star7th 目前你说的话,只能符合你认知内的实事,并不代表别人的,你觉得没有夸大,别人未必这么觉得,所以别人说你的可能最好看是吹牛,你就认为别人在跟你顶,然后你就顶回去了呗。其实你换个方法提问,评论区会和谐很多,当然,是否和谐也无所谓,你觉得好看就好看就是了,心情不受影响就 ok 了
star7th
2023-06-28 10:14:19 +08:00
@Jynxio

你可以尝试发一下你认为的 「国内颜值最高的 XXX 」 。

如果你能像 26 楼那样有理有据列出来,我会虚心接受你意见。
但是如果只是发泄情绪,那我觉得你这么说,没有必要。
bjzhush
2023-06-28 10:14:20 +08:00
说真的丑爆了!!!!
功能另说!!!
star7th
2023-06-28 10:16:03 +08:00
@bjzhush

如果你能像 26 楼那样有理有据列出来,我会虚心接受你意见。
但是如果只是发泄情绪,那我觉得你这么说,没有必要。
star7th
2023-06-28 10:17:45 +08:00
@shuxhan

你发的这个,应该是高仿 gitbook 的设计。我后面学习参考下。
ZGame
2023-06-28 10:17:53 +08:00
@star7th 可以关注一下 AFFINE 这个项目。目前在我心里这个是文档类开源 No.1
https://github.com/toeverything/AFFiNE
star7th
2023-06-28 10:20:43 +08:00
@xiaoz

新版的变化主要在于 ,左侧目录树支持拖动支持右击操作等等,比之前的操作方式省事不少。
还有移动端的样式也优化了很多,方便手机用户查看。比如说可以放一些 app 产品帮助文档,分享到手机给用户看。

这是一个专为移动设备优化的页面(即为了让你能够在 Google 搜索结果里秒开这个页面),如果你希望参与 V2EX 社区的讨论,你可以继续到 V2EX 上打开本讨论主题的完整版本。

https://www.fyfyfm.apispeedy.workers.dev/t/952265

V2EX 是创意工作者们的社区,是一个分享自己正在做的有趣事物、交流想法,可以遇见新朋友甚至新机会的地方。

V2EX is a community of developers, designers and creative people.

© 2021 V2EX