这是一个创建于 1219 天前的主题，其中的信息可能已经有所发展或是发生改变。
特定需求：
比如搞一个前端库文档站点一共有 2 个页面：
一个页面的侧边栏菜单 menu 让用户不关注 api 细节，由浅入深跑通组件，有：安装、起步、基础用法、高级用法、插件接入。
另一个页面的侧边栏菜单 menu 全是 api 范畴的，详尽介绍 api 的：全局配置 api 、构造参数 api 、实例参数 api 、实例方法 api
像前端库 vue 的官方文档也是单独把 api 范畴的文档抽成一个站点页面，但是每次点击站内引言链接都是要打开新页面或者直接跳转，这样站内两个页面切换查阅参照，感受到了严重的不适，有没有？？无论硬件设备是窄屏 15 寸还是宽屏 27 寸，都觉得很鸡肋，没有利用好浏览器页面空间。对于引言的引用，其实只需要上下滑动页面或者能瞄几眼内容互相参照就可以。
反过来看，点击一个页面上的链接，然后右边滑出半屏显示另一个页面(无侧边栏)对应文档的区域的 iframe 或者弹出一个右侧边抽屉半屏显示对应内容。提供多这种站内引言链接方式，觉得有点爽啊。好像市面上没有这种思想、用得顺手的工具。
追加内容：剩下的文档工具基本需求
- markdown 编写文档
- 生成静态网页，不需要 Web 接口数据支持
- 可以插入 Javascript demo
- 可以优雅地插入代码示例，代码示例模块可以点击折叠
- 不需要类似 swagger 的 Web 接口测试工具和接口描述等等
市面上其实挺多偏前端的文档生成器已经满足上述这些基本需求了。比如 vuepress 。而特定需求能实现半屏滑出显示的却基本没见到
比如搞一个前端库文档站点一共有 2 个页面：
一个页面的侧边栏菜单 menu 让用户不关注 api 细节，由浅入深跑通组件，有：安装、起步、基础用法、高级用法、插件接入。
另一个页面的侧边栏菜单 menu 全是 api 范畴的，详尽介绍 api 的：全局配置 api 、构造参数 api 、实例参数 api 、实例方法 api
像前端库 vue 的官方文档也是单独把 api 范畴的文档抽成一个站点页面，但是每次点击站内引言链接都是要打开新页面或者直接跳转，这样站内两个页面切换查阅参照，感受到了严重的不适，有没有？？无论硬件设备是窄屏 15 寸还是宽屏 27 寸，都觉得很鸡肋，没有利用好浏览器页面空间。对于引言的引用，其实只需要上下滑动页面或者能瞄几眼内容互相参照就可以。
反过来看，点击一个页面上的链接，然后右边滑出半屏显示另一个页面(无侧边栏)对应文档的区域的 iframe 或者弹出一个右侧边抽屉半屏显示对应内容。提供多这种站内引言链接方式，觉得有点爽啊。好像市面上没有这种思想、用得顺手的工具。
追加内容：剩下的文档工具基本需求
- markdown 编写文档
- 生成静态网页，不需要 Web 接口数据支持
- 可以插入 Javascript demo
- 可以优雅地插入代码示例，代码示例模块可以点击折叠
- 不需要类似 swagger 的 Web 接口测试工具和接口描述等等
市面上其实挺多偏前端的文档生成器已经满足上述这些基本需求了。比如 vuepress 。而特定需求能实现半屏滑出显示的却基本没见到
目前尚无回复
Select Language