快速上手

Tip: 如果你只是想先体验一下本项目,你可以忽略语雀的注册和创建部分,直接进入第三步。

1 注册语雀

如果你已经注册,可以忽略这一步。这里是注册地址,可以使用手机、钉钉、支付宝或者微信快捷登陆:

image.png

2 新建一个知识库

什么是知识库呢?在语雀中,一个知识库是用户创造的文档、设计稿、表格的一个集合。如果你是 programmer,你可以将其理解为 Github 的一个 repo。

可参考官方文档来新建一个知识库

3 新建一个 VuePress 项目

如果你已经很熟悉 VuePress,你可以跳过此节。

通过运行下述指令来新建一个项目:

mkdir my-site && cd my-site
yarn init -y
yarn add vuepress@next vuepress-plugin-yuque -D 

接着,在 package.json 中新增两个 npm script:

{
 "scripts": {
   "dev": "vuepress dev .",
   "build": "vuepress build ."
 }
} 

新建 VuePress 的配置 .vuepress/config.js :

module.exports = {
 // 站点配置
 plugins: [
   [
     'vuepress-plugin-yuque', {
       repoUrl: '你的知识库的地址',
     }
   ]
 ]
} 

如果你只是想测试本项目,你可以直接使用一些现有的公开知识库,如:

可以移步这里来了解 VuePress 所支持的所有站点配置

可以移步这里来了解本插件的配置

然后,你就可以开始预览你的站点了:

yarn dev # 或者:npm run dev 

要生成静态的 HTML 文件,运行:

yarn build # 或者:npm run build 

默认情况下,文件将会被生成在 .vuepress/dist,当然,你也可以通过 .vuepress/config.js 中的 dest 字段来修改,生成的文件可以部署到任意的静态文件服务器上,参考 部署 来了解更多。



使用语雀查看