介绍

TL;DR: VuePress 的核心是静态网站生成,而语雀的优势在于文档编辑,如果能够将两者结合起来,你将能得到一种从文档编写、管理,到网站发布,都比以前更流畅的体验。


什么是 VuePress?

VuePress 由两部分组成:第一部分是一个极简静态网站生成器,它包含由 Vue 驱动的主题系统插件 API,另一个部分是为书写技术文档而优化的默认主题,它的诞生初衷是为了支持 Vue 及其子项目的文档需求。[1]

除此之外,如果你是 Markdown 狂热粉,由于 VuePress 允许你在 Markdown 中书写 Vue ,从而大大提升了 Markdown 语法的拓展性;如果你喜欢“快”,你会发现,自动生成的 Service Worker 和 prefetch 让每一个 VuePress 站点的访问速度都出奇地快;如果你喜欢“开箱即用”,VuePress 的响应式布局、可选的主页、实用的标题搜索、可配置的 导航栏 和 侧边栏 等,都是你无需开发就能获得的体验。

想了解更多,请移步 VuePress 官网:https://vuepress.vuejs.org

什么是语雀?

image.png

「语雀」是一个「知识创作与分享工具」,孵化自 蚂蚁金服 ,是 体验科技 理念下的一款创新产品,已是 5万+ 阿里员工进行文档编写、知识沉淀的标配。[2]

在线的文档写作工具有很多,为什么非要选择语雀呢?有如下几个理由:

想了解更多,请移步语雀帮助文档 https://www.yuque.com/yuque/help

创作动机

语雀解决了人们在线编写、存储、整理和分享文档的痛点,而 VuePress 关注的是开发者快速建立文档类网站的需求。当两者结合起来:

  • 对于语雀用户,你将能够轻松地将一个语雀仓库发布为 VuePress 站点,并部署到任何静态服务器上;
  • 对于 VuePress 用户,由于语雀强大的可视化文档编辑器,你将无须将 markdown、 assets 存储于本地,也无须再书写 markdown 文件;同时,语雀的可视化目录编排已经做到了让你不用再关注目录的配置,这个强大的特性,完全可以让 VuePress 用户也收益。

以上,便是创建这个项目的动机。



使用语雀查看