Skip to content

Commit 2d174da

Browse files
committed
chore: update docs
1 parent d9636d4 commit 2d174da

File tree

5 files changed

+23
-68
lines changed

5 files changed

+23
-68
lines changed

.vscode/settings.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"markdown.extension.toc.updateOnSave": false
3+
}

src/guide/README.md

Lines changed: 5 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -20,34 +20,24 @@ During build, we create a server-rendered version of the VuePress site and rende
2020

2121
## Why Not ...?
2222

23-
::: note Nuxt
23+
### Nuxt
2424

2525
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.
2626

27-
:::
28-
29-
::: note VitePress
27+
### VitePress
3028

3129
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.
3230

3331
It might not be an appropriate comparison, but you can take VuePress and VitePress as Laravel and Lumen.
3432

35-
:::
36-
37-
::: note Docsify / Docute
33+
### Docsify / Docute
3834

3935
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.
4036

41-
:::
42-
43-
::: note Hexo
37+
### Hexo
4438

4539
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.
4640

47-
:::
48-
49-
::: note GitBook
41+
### GitBook
5042

5143
We’ve been using GitBook for most of our sub project docs. 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.
52-
53-
:::

src/reference/plugin-api.md

Lines changed: 5 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -17,25 +17,11 @@ Plugins should be used before initialization. The basic options will be handled
1717

1818
The following hooks will be processed when initializing app:
1919

20-
- [Plugin API](#plugin-api)
21-
- [Overview](#overview)
22-
- [Basic Options](#basic-options)
23-
- [name](#name)
24-
- [multiple](#multiple)
25-
- [Development Hooks](#development-hooks)
26-
- [alias](#alias)
27-
- [clientConfigFile](#clientconfigfile)
28-
- [define](#define)
29-
- [extendsBundlerOptions](#extendsbundleroptions)
30-
- [extendsMarkdownOptions](#extendsmarkdownoptions)
31-
- [extendsMarkdown](#extendsmarkdown)
32-
- [extendsPageOptions](#extendspageoptions)
33-
- [extendsPage](#extendspage)
34-
- [Lifecycle Hooks](#lifecycle-hooks)
35-
- [onInitialized](#oninitialized)
36-
- [onPrepared](#onprepared)
37-
- [onWatched](#onwatched)
38-
- [onGenerated](#ongenerated)
20+
- [extendsMarkdownOptions](#extendsmarkdownoptions)
21+
- [extendsMarkdown](#extendsmarkdown)
22+
- [extendsPageOptions](#extendspageoptions)
23+
- [extendsPage](#extendspage)
24+
- [onInitialized](#oninitialized)
3925

4026
The following hooks will be processed when preparing files:
4127

src/zh/guide/README.md

Lines changed: 5 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -20,34 +20,24 @@ VuePress 诞生的初衷是为了支持 Vue.js 及其子项目的文档需求,
2020

2121
## 为什么不是 ...?
2222

23-
::: note Nuxt
23+
### Nuxt
2424

2525
Nuxt 是一套出色的 Vue SSR 框架, VuePress 能做的事情,Nuxt 实际上也同样能够胜任。但 Nuxt 是为构建应用程序而生的,而 VuePress 则更为轻量化并且专注在以内容为中心的静态网站上。
2626

27-
:::
28-
29-
::: note VitePress
27+
### VitePress
3028

3129
VitePress 是 VuePress 的孪生兄弟,它同样由 Vue.js 团队创建和维护。 VitePress 甚至比 VuePress 要更轻更快,但它在灵活性和可配置性上作出了一些让步,比如它不支持插件系统。当然,如果你没有进阶的定制化需求, VitePress 已经足够支持你将你的内容部署到线上。
3230

3331
这个比喻可能不是很恰当,但是你可以把 VuePress 和 VitePress 的关系看作 Laravel 和 Lumen 。
3432

35-
:::
36-
37-
::: note Docsify / Docute
33+
### Docsify / Docute
3834

3935
这两个项目同样都是基于 Vue,然而它们都是完全的运行时驱动,因此对 SEO 不够友好。如果你并不关注 SEO,同时也不想安装大量依赖,它们仍然是非常好的选择!
4036

41-
:::
42-
43-
::: note Hexo
37+
### Hexo
4438

4539
Hexo 一直驱动着 Vue 2.x 的文档。Hexo 最大的问题在于他的主题系统太过于静态以及过度地依赖纯字符串,而我们十分希望能够好好地利用 Vue 来处理我们的布局和交互。同时,Hexo 在配置 Markdown 渲染方面的灵活性也不是最佳的。
4640

47-
:::
48-
49-
::: note GitBook
41+
### GitBook
5042

5143
过去我们的子项目文档一直都在使用 GitBook 。 GitBook 最大的问题在于当文件很多时,每次编辑后的重新加载时间长得令人无法忍受。它的默认主题导航结构也比较有限制性,并且,主题系统也不是 Vue 驱动的。GitBook 背后的团队如今也更专注于将其打造为一个商业产品而不是开源工具。
52-
53-
:::

src/zh/reference/plugin-api.md

Lines changed: 5 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -17,25 +17,11 @@ icon: fa6-solid:plug
1717

1818
下列 Hooks 会在初始化 App 时处理:
1919

20-
- [插件 API](#插件-api)
21-
- [概览](#概览)
22-
- [基础配置项](#基础配置项)
23-
- [name](#name)
24-
- [multiple](#multiple)
25-
- [开发 Hooks](#开发-hooks)
26-
- [alias](#alias)
27-
- [clientConfigFile](#clientconfigfile)
28-
- [define](#define)
29-
- [extendsBundlerOptions](#extendsbundleroptions)
30-
- [extendsMarkdownOptions](#extendsmarkdownoptions)
31-
- [extendsMarkdown](#extendsmarkdown)
32-
- [extendsPageOptions](#extendspageoptions)
33-
- [extendsPage](#extendspage)
34-
- [生命周期 Hooks](#生命周期-hooks)
35-
- [onInitialized](#oninitialized)
36-
- [onPrepared](#onprepared)
37-
- [onWatched](#onwatched)
38-
- [onGenerated](#ongenerated)
20+
- [extendsMarkdownOptions](#extendsmarkdownoptions)
21+
- [extendsMarkdown](#extendsmarkdown)
22+
- [extendsPageOptions](#extendspageoptions)
23+
- [extendsPage](#extendspage)
24+
- [onInitialized](#oninitialized)
3925

4026
下列 Hooks 会在准备文件时处理:
4127

0 commit comments

Comments
 (0)