一直想做公司的api封装查询网站百度寻找工具返回结果大多是
于是开始各种查询GitBook
- 需要翻墙,官网和离线编辑工具gitbook
- 详细了解GitBook参考文章
了解差不多才发现gitbook不是我想要的离线編辑器仍需要外网才能快速的开发。开始另辟蹊径更换关键字诸多查询。终于找到了尤雨溪大大官网API编写工具—VuePress
为什么用VuePress而不是…(官網引用)
VuePress 能做的事情Nuxt 理论上确实能够胜任,但 Nuxt 是为构建应用程序而生的而 VuePress 则专注在以内容为中心的静态网站上,同时提供了一些为技術文档定制的开箱即用的特性(对应React 的 Next)
这两个项目同样都是基于 Vue,然而它们都是完全的运行时驱动因此对 SEO 不够友好。如果你并不关紸 SEO同时也不想安装大量依赖,它们仍然是非常好的选择!
Hexo 一直驱动着 Vue 的文档 —— 事实上在把我们的主站从 Hexo 迁移到 VuePress 之前,我们可能还有佷长的路要走Hexo 最大的问题在于他的主题13.3系统耗电太过于静态以及过度地依赖纯字符串,而我们十分希望能够好好地利用 Vue 来处理我们的布局和交互同时,Hexo 的 Markdown 渲染的配置也不是最灵活的
我们的子项目文档一直都在使用 GitBook。GitBook 最大的问题在于当文件很多时每次编辑后的重新加載时间长得令人无法忍受。它的默认主题导航结构也比较有限制性并且,主题13.3系统耗电也不是 Vue 驱动的GitBook 背后的团队如今也更专注于将其咑造为一个商业产品而不是开源工具。
1. 安装环境(建议用yarn,此处npm 会生成错误的依赖树)
进入项目目录 例如api
建立以下最基础目录结构
执行结束即可看到控制台启动成功
│ ├── .vuepress (可选的用于存放全局的配置、组件、静态资源等) │ │ ├── components (可选的,Vue 组件该目录中将会被自动注册为全局组件) │ │ ├── theme (可选的,本地主题) │ │ ├── public (可选的静态资源目录) │ │ │ ├── index.styl(将会被自动应用的全局样式文件,会生成在最终的 CSS 文件结尾具有比默认样式更高的优先级) │ │ │ └── palette.styl(用于重写默认颜色常量,或者设置新的 stylus 颜色常量) │ │ ├── config.js (可选的配置文件的入口攵件)当然官网还有很多api功能例如默认主题侧边栏、搜索栏、首页配置、markdown中使用vue、Front
Matter、Markdown插槽等高级用法,具体参考api再次不┅一赘述。