Skip to content

Commit 209966d

Browse files
committed
docs: update introduction and relationship with vitepress
1 parent 4e84d36 commit 209966d

File tree

2 files changed

+13
-41
lines changed

2 files changed

+13
-41
lines changed

docs/guide/introduction.md

Lines changed: 6 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Introduction
22

3-
VuePress is a markdown-centered static site generator. You can write your content (documentations, blogs, etc.) in [Markdown](https://en.wikipedia.org/wiki/Markdown), then VuePress will help you to generate a static site to host them.
3+
VuePress is a markdown-centered static site generator (SSG). You can write your content (documentations, blogs, etc.) in [Markdown](https://en.wikipedia.org/wiki/Markdown), then VuePress will help you to generate a static site to host them.
44

55
The purpose of creating VuePress was to support the documentation of Vue.js and its sub-projects, but now it has been helping a large amount of users to build their documentation, blogs, and other static sites.
66

@@ -14,26 +14,12 @@ During development, we start a normal dev-server, and serve the VuePress site as
1414

1515
During build, we create a server-rendered version of the VuePress site and render the corresponding HTML by virtually visiting each route. This approach is inspired by [Nuxt](https://nuxtjs.org/)'s `nuxt generate` command and other projects like [Gatsby](https://www.gatsbyjs.org/).
1616

17-
## Why Not ...?
17+
## Relationship with VitePress
1818

19-
### Nuxt
19+
VitePress can be seen as the younger sibling of VuePress. Both were originally created by Evan You, the author of Vue.js. Today, VitePress is maintained by the Vue.js team, while VuePress is maintained by the VuePress team.
2020

21-
Nuxt is an outstanding Vue SSR framework, and it is capable of doing what VuePress does. But Nuxt is designed for building applications, while VuePress is more lightweight and focused on content-centric static sites.
21+
The history goes like this: VuePress v0 and v1 were built on top of Webpack. Later, when Evan created Vite, he started a new static site generator based on it — VitePress — reusing some ideas and code from VuePress. At the same time, the community forked the VuePress v2 branch, continued its development, and added support for both Webpack and Vite.
2222

23-
### VitePress
23+
At one point, we discussed merging the two projects under the VuePress brand. However, over time their goals and technical directions diverged. As a result, the Vue.js team chose to focus on VitePress, while the community — now the VuePress team — took over VuePress and continues to drive its development forward.
2424

25-
VitePress is the little brother of VuePress. It's also created and maintained by our Vue.js team. It's even more lightweight and faster than VuePress. However, as a tradeoff, it's more opinionated and less configurable. For example, it does not support plugins. But VitePress is powerful enough to make your content online if you don't need advanced customizations.
26-
27-
It might not be an appropriate comparison, but you can take VuePress and VitePress as Laravel and Lumen.
28-
29-
### Docsify / Docute
30-
31-
Both are great projects and also Vue-powered. Except they are both fully runtime-driven and therefore not SEO-friendly. If you don’t care for SEO and don’t want to mess with installing dependencies, these are still great choices.
32-
33-
### Hexo
34-
35-
Hexo has been serving the Vue 2.x docs well. The biggest problem is that its theming system is static and string-based - we want to take advantage of Vue for both the layout and the interactivity. Also, Hexo’s Markdown rendering isn’t the most flexible to configure.
36-
37-
### GitBook
38-
39-
We’ve been using GitBook for most of our subproject documentation. However, the primary problem with GitBook is that its development reload performance is intolerable with a large amount of files. The default theme also has a pretty limiting navigation structure, and the theming system is, again, not Vue based. The team behind GitBook is also more focused on turning it into a commercial product rather than an open-source tool.
25+
As a user, you can choose either project depending on your needs. VitePress is tightly integrated with Vite. VuePress, on the other hand, is designed to support different bundlers: it supports Webpack and Vite today, and open to any other bundlers. In addition, VuePress has an official [ecosystem](https://ecosystem.vuejs.press/) project and provides a wide range of plugins, making it easier to build sites with features.

docs/zh/guide/introduction.md

Lines changed: 7 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,39 +1,25 @@
11
# 介绍
22

3-
VuePress 是一个以 Markdown 为中心的静态网站生成器。你可以使用 [Markdown](https://zh.wikipedia.org/wiki/Markdown) 来书写内容(如文档、博客等),然后 VuePress 会帮助你生成一个静态网站来展示它们。
3+
VuePress 是一个以 Markdown 为中心的静态网站生成器(Static Site Generator, SSG)。你可以使用 [Markdown](https://zh.wikipedia.org/wiki/Markdown) 来书写内容(如文档、博客等),然后 VuePress 会帮助你生成一个静态网站来展示它们。
44

55
VuePress 诞生的初衷是为了支持 Vue.js 及其子项目的文档需求,但是现在它已经在帮助大量用户构建他们的文档、博客和其他静态网站。
66

77
## 它是如何工作的?
88

9-
一个 VuePress 站点本质上是一个由 [Vue](https://vuejs.org/)[Vue Router](https://router.vuejs.org) 驱动的单页面应用 (SPA)。
9+
一个 VuePress 站点本质上是一个由 [Vue](https://vuejs.org/)[Vue Router](https://router.vuejs.org) 驱动的单页面应用 (Single-Page Application, SPA)。
1010

1111
路由会根据你的 Markdown 文件的相对路径来自动生成。每个 Markdown 文件都通过 [markdown-it](https://github.com/markdown-it/markdown-it) 编译为 HTML ,然后将其作为 Vue 组件的模板。因此,你可以在 Markdown 文件中直接使用 Vue 语法,便于你嵌入一些动态内容。
1212

1313
在开发过程中,我们启动一个常规的开发服务器 (dev-server) ,并将 VuePress 站点作为一个常规的 SPA。如果你以前使用过 Vue 的话,你在使用时会感受到非常熟悉的开发体验。
1414

1515
在构建过程中,我们会为 VuePress 站点创建一个服务端渲染 (SSR) 的版本,然后通过虚拟访问每一条路径来渲染对应的 HTML 。这种做法的灵感来源于 [Nuxt](https://nuxtjs.org/)`nuxt generate` 命令,以及其他的一些项目,比如 [Gatsby](https://www.gatsbyjs.org/)
1616

17-
## 为什么不是 ...?
17+
## 与 VitePress 的关系
1818

19-
### Nuxt
19+
VitePress 可以看作是 VuePress 的孪生兄弟。它们最初都是由 Vue.js 的作者 Evan You 创建。如今,VitePress 由 Vue.js 团队维护,而 VuePress 则由 VuePress 团队维护。
2020

21-
Nuxt 是一套出色的 Vue SSR 框架, VuePress 能做的事情,Nuxt 实际上也同样能够胜任。但 Nuxt 是为构建应用程序而生的,而 VuePress 则更为轻量化并且专注在以内容为中心的静态网站上
21+
两个项目的大致历史是这样的:VuePress v0 和 v1 是基于 Webpack 构建的。后来 Evan 创建了 Vite ,他基于 Vite 开发了一个新的静态站点生成器 —— VitePress —— 复用了 VuePress 的一些理念和代码。与此同时,社区 Fork 了 VuePress v2 分支,继续推动其发展,并为其增加了对 Webpack 和 Vite 的支持
2222

23-
### VitePress
23+
我们曾经考虑过将这两个项目合并到 VuePress 这一名称下。然而,随着时间的推移,它们的目标和技术路线逐渐分化。因此,Vue.js 团队选择专注于 VitePress,而社区 —— 也就是现在的 VuePress 团队 —— 接手了 VuePress,并持续推动其发展。
2424

25-
VitePress 是 VuePress 的孪生兄弟,它同样由 Vue.js 团队创建和维护。 VitePress 甚至比 VuePress 要更轻更快,但它在灵活性和可配置性上作出了一些让步,比如它不支持插件系统。当然,如果你没有进阶的定制化需求, VitePress 已经足够支持你将你的内容部署到线上。
26-
27-
这个比喻可能不是很恰当,但是你可以把 VuePress 和 VitePress 的关系看作 Laravel 和 Lumen 。
28-
29-
### Docsify / Docute
30-
31-
这两个项目同样都是基于 Vue,然而它们都是完全的运行时驱动,因此对 SEO 不够友好。如果你并不关注 SEO,同时也不想安装大量依赖,它们仍然是非常好的选择!
32-
33-
### Hexo
34-
35-
Hexo 一直驱动着 Vue 2.x 的文档。Hexo 最大的问题在于他的主题系统太过于静态以及过度地依赖纯字符串,而我们十分希望能够好好地利用 Vue 来处理我们的布局和交互。同时,Hexo 在配置 Markdown 渲染方面的灵活性也不是最佳的。
36-
37-
### GitBook
38-
39-
过去我们的子项目文档一直都在使用 GitBook 。 GitBook 最大的问题在于当文件很多时,每次编辑后的重新加载时间长得令人无法忍受。它的默认主题导航结构也比较有限制性,并且,主题系统也不是 Vue 驱动的。GitBook 背后的团队如今也更专注于将其打造为一个商业产品而不是开源工具。
25+
作为用户,你可以根据自由选择使用哪个项目。VitePress 与 Vite 深度集成。而 VuePress 则更开放,可以支持不同的打包工具:目前支持 Webpack 和 Vite,并且同样可以支持其他打包工具。此外,VuePress 拥有官方的 [生态系统](https://ecosystem.vuejs.press/) 项目,提供了大量的插件,为你构建功能丰富的网站提供了便利。

0 commit comments

Comments
 (0)