star7th / showdoc

ShowDoc is a tool greatly applicable for an IT team to share documents online一个非常适合IT团队的在线API文档、技术文档工具

https://www.showdoc.com.cn

Other

12.24k stars 2.19k forks source link

Open clso opened 3 months ago

clso commented 3 months ago

自动给页尾添加上下页的链接，或者使用伪代码如 {{next}} {{pre}}生成上下文档的链接

另外，几个 editormd.js 文件中使用了 cdn.staticfile.org 的文件加速，目前 staticfile.org staticfile.net bootcdn.cn bootcdn.com 均已被CDN投毒，已被各个广告屏蔽插件所屏蔽，建议换掉

star7th commented 3 months ago

已经推送了master分支代码，不再使用cdn加载js。至于你说的上下页面，其实showdoc比较推送用左侧栏来做切换，我不清楚用上下页的方式是否有必要

clso commented 3 months ago

已经推送了master分支代码，不再使用cdn加载js。至于你说的上下页面，其实showdoc比较推送用左侧栏来做切换，我不清楚用上下页的方式是否有必要

面对章节比较多的教程或者文章，“下一页”的链接可以避免用户翻找、点击下一章的过程，可以让用户更专注于阅读。这个功能其他文档应用基本都有，如 Gitbook、Docsify 都支持这项功能。

star7th commented 3 months ago

但是使用场景不一样。showdoc更偏重于写技术文档，api文档。这种文档里，上一页下一页功能用得少，而如果永久出现按钮，或者专门为此开发一种语法，似乎都有种不太必要的感觉。再看看吧