1
1
# 介绍
2
2
3
- VuePress 由两部分组成:一个是由 Vue 驱动的极简主题系统带来的静态网站生成器,一个是为书写技术文档而优化的默认主题,它的诞生初衷是为了助力 Vue 及其子项目书写文档的需求 。
4
-
5
- 每一个由 VuePress 生成的页面都有自己预渲染好的 HTML,也因此带来了非常好的加载性能和搜索引擎优化 (SEO)。同时,一旦页面被加载,Vue 将接管这些静态内容,并将其转换成一个完整的单页应用(SPA),其他的页面都将在用户浏览到的时候按需加载 。
3
+ VuePress 由两部分组成:一部分是支持用 Vue 开发主题的极简静态网站生成器,另一个部分是为书写技术文档而优化的默认主题。它的诞生初衷是为了支持 Vue 及其子项目的文档需求 。
4
+
5
+ 每一个由 VuePress 生成的页面都带有预渲染好的 HTML,也因此具有非常好的加载性能和搜索引擎优化 (SEO)。同时,一旦页面被加载,Vue 将接管这些静态内容,并将其转换成一个完整的单页应用(SPA),其他的页面则会只在用户浏览到的时候才按需加载 。
6
6
7
7
## 它是如何工作的?
8
8
9
- 事实上,一个 VuePress 网站是一个由 [ Vue] ( http://vuejs.org/ ) 、[ Vue Router] ( https://github.com/vuejs/vue-router ) 和 [ Webpack ] ( http://webpack.js.org/ ) 驱动的单页应用。如果你以前使用过 Vue 的话,当你在开发一个自定义主题的时候,你将会回到曾经那非常熟悉的开发体验 ,你甚至可以使用 Vue DevTools 去调试你的自定义主题。
9
+ 事实上,一个 VuePress 网站是一个由 [ Vue] ( http://vuejs.org/ ) 、[ Vue Router] ( https://github.com/vuejs/vue-router ) 和 [ webpack ] ( http://webpack.js.org/ ) 驱动的单页应用。如果你以前使用过 Vue 的话,当你在开发一个自定义主题的时候,你会感受到非常熟悉的开发体验 ,你甚至可以使用 Vue DevTools 去调试你的自定义主题。
10
10
11
- 在构建过程中,我们创建了一个服务端渲染 (SSR)版本的应用,同时在访问每一个路由的时候会渲染对应的HTML, 这种做法的灵感来源于 [ Nuxt] ( https://nuxtjs.org/ ) 的 ` nuxt generate ` 命令,以及其他的一些项目,如 [ Gatsby] ( https://www.gatsbyjs.org/ ) 。
11
+ 在构建时,我们会为应用创建一个服务端渲染 (SSR)的版本,然后通过虚拟访问每一条路径来渲染对应的HTML。 这种做法的灵感来源于 [ Nuxt] ( https://nuxtjs.org/ ) 的 ` nuxt generate ` 命令,以及其他的一些项目,比如 [ Gatsby] ( https://www.gatsbyjs.org/ ) 。
12
12
13
13
## 特性
14
14
15
- - [ 内置的 Markdown 拓展] ( ./markdown.md ) ,为技术文档而生
16
- - [ 在 Markdown 文件使用 Vue 组件的能力] ( ./using-vue.md )
15
+ - 为技术文档而优化的 [ 内置 Markdown 拓展] ( ./markdown.md )
16
+ - [ 在 Markdown 文件中使用 Vue 组件的能力] ( ./using-vue.md )
17
17
- [ Vue 驱动的自定义主题系统] ( ./custom-themes.md )
18
- - 支持 PWA
19
- - 集成了 Google Analytics
20
- - 一个默认的主题包含:
18
+ - 自动生成 Service Worker
19
+ - Google Analytics 集成
20
+ - 多语言支持
21
+ - 默认主题包含:
21
22
- 响应式布局
22
23
- 可选的主页
23
24
- 简洁的开箱即用的标题搜索
@@ -31,19 +32,19 @@ VuePress 仍然处于开发中,这里有一些目前还不支持、但已经
31
32
- Algolia DocSearch 的集成
32
33
- 博客系统
33
34
34
- 欢迎你的 Contribution!
35
+ 我们欢迎你为 VuePress 的开发作出贡献。
35
36
36
37
## 为什么不是...?
37
38
38
39
### Nuxt
39
40
40
- VuePress 能做的事情,Nuxt 同样能胜任 ,但 Nuxt 是为构建应用程序而生的,而 VuePress 则专注在以内容为中心的静态网站上,同时提供了一些为技术文档定制的开箱即用的特性。
41
+ VuePress 能做的事情,Nuxt 理论上确实能够胜任 ,但 Nuxt 是为构建应用程序而生的,而 VuePress 则专注在以内容为中心的静态网站上,同时提供了一些为技术文档定制的开箱即用的特性。
41
42
42
43
### Docsify / Docute
43
44
44
- 这两个项目同样都是 Vue 驱动的 ,然而它们都是完全的运行时驱动,因此对 SEO 不够友好。如果你并不关注 SEO,同时也不想因为安装依赖而弄糊涂 ,它们仍然是非常好的选择!
45
+ 这两个项目同样都是基于 Vue,然而它们都是完全的运行时驱动,因此对 SEO 不够友好。如果你并不关注 SEO,同时也不想安装大量依赖 ,它们仍然是非常好的选择!
45
46
46
47
### Hexo
47
48
48
- Hexo 一直驱动着 Vue 的文档 —— 事实上,在决定开始从 Hexo 迁移到 VuePress 之前,我们还有很长的路要走 。Hexo 最大的问题在于他的主题系统太过于静态以及过度地依赖纯字符串,而我们十分希望能够好好地利用 Vue 来处理我们的布局和交互,同时,Hexo 的 Markdown 渲染的配置也不是最灵活的。
49
+ Hexo 一直驱动着 Vue 的文档 —— 事实上,在把我们的主站从 Hexo 迁移到 VuePress 之前,我们可能还有很长的路要走 。Hexo 最大的问题在于他的主题系统太过于静态以及过度地依赖纯字符串,而我们十分希望能够好好地利用 Vue 来处理我们的布局和交互,同时,Hexo 的 Markdown 渲染的配置也不是最灵活的。
49
50
0 commit comments