chore: update docs

vuepress · Oct 10, 2023 · 2d174da · 2d174da
1 parent d9636d4
commit 2d174da
Show file tree

Hide file tree

Showing 5 changed files with 23 additions and 68 deletions.
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -0,0 +1,3 @@
+{
+  "markdown.extension.toc.updateOnSave": false
+}
diff --git a/src/guide/README.md b/src/guide/README.md
@@ -20,34 +20,24 @@ During build, we create a server-rendered version of the VuePress site and rende
 
 ## Why Not ...?
 
-::: note Nuxt
+### Nuxt
 
 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.
 
-:::
-
-::: note VitePress
+### VitePress
 
 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.
 
 It might not be an appropriate comparison, but you can take VuePress and VitePress as Laravel and Lumen.
 
-:::
-
-::: note Docsify / Docute
+### Docsify / Docute
 
 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.
 
-:::
-
-::: note Hexo
+### Hexo
 
 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.
 
-:::
-
-::: note GitBook
+### GitBook
 
 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.
-
-:::
diff --git a/src/reference/plugin-api.md b/src/reference/plugin-api.md
@@ -17,25 +17,11 @@ Plugins should be used before initialization. The basic options will be handled
 
 The following hooks will be processed when initializing app:
 
-- [Plugin API](#plugin-api)
-  - [Overview](#overview)
-  - [Basic Options](#basic-options)
-    - [name](#name)
-    - [multiple](#multiple)
-  - [Development Hooks](#development-hooks)
-    - [alias](#alias)
-    - [clientConfigFile](#clientconfigfile)
-    - [define](#define)
-    - [extendsBundlerOptions](#extendsbundleroptions)
-    - [extendsMarkdownOptions](#extendsmarkdownoptions)
-    - [extendsMarkdown](#extendsmarkdown)
-    - [extendsPageOptions](#extendspageoptions)
-    - [extendsPage](#extendspage)
-  - [Lifecycle Hooks](#lifecycle-hooks)
-    - [onInitialized](#oninitialized)
-    - [onPrepared](#onprepared)
-    - [onWatched](#onwatched)
-    - [onGenerated](#ongenerated)
+- [extendsMarkdownOptions](#extendsmarkdownoptions)
+- [extendsMarkdown](#extendsmarkdown)
+- [extendsPageOptions](#extendspageoptions)
+- [extendsPage](#extendspage)
+- [onInitialized](#oninitialized)
 
 The following hooks will be processed when preparing files:
 

diff --git a/src/zh/guide/README.md b/src/zh/guide/README.md
@@ -20,34 +20,24 @@ VuePress 诞生的初衷是为了支持 Vue.js 及其子项目的文档需求，
 
 ## 为什么不是 ...?
 
-::: note Nuxt
+### Nuxt
 
 Nuxt 是一套出色的 Vue SSR 框架， VuePress 能做的事情，Nuxt 实际上也同样能够胜任。但 Nuxt 是为构建应用程序而生的，而 VuePress 则更为轻量化并且专注在以内容为中心的静态网站上。
 
-:::
-
-::: note VitePress
+### VitePress
 
 VitePress 是 VuePress 的孪生兄弟，它同样由 Vue.js 团队创建和维护。 VitePress 甚至比 VuePress 要更轻更快，但它在灵活性和可配置性上作出了一些让步，比如它不支持插件系统。当然，如果你没有进阶的定制化需求， VitePress 已经足够支持你将你的内容部署到线上。
 
 这个比喻可能不是很恰当，但是你可以把 VuePress 和 VitePress 的关系看作 Laravel 和 Lumen 。
 
-:::
-
-::: note Docsify / Docute
+### Docsify / Docute
 
 这两个项目同样都是基于 Vue，然而它们都是完全的运行时驱动，因此对 SEO 不够友好。如果你并不关注 SEO，同时也不想安装大量依赖，它们仍然是非常好的选择！
 
-:::
-
-::: note Hexo
+### Hexo
 
 Hexo 一直驱动着 Vue 2.x 的文档。Hexo 最大的问题在于他的主题系统太过于静态以及过度地依赖纯字符串，而我们十分希望能够好好地利用 Vue 来处理我们的布局和交互。同时，Hexo 在配置 Markdown 渲染方面的灵活性也不是最佳的。
 
-:::
-
-::: note GitBook
+### GitBook
 
 过去我们的子项目文档一直都在使用 GitBook 。 GitBook 最大的问题在于当文件很多时，每次编辑后的重新加载时间长得令人无法忍受。它的默认主题导航结构也比较有限制性，并且，主题系统也不是 Vue 驱动的。GitBook 背后的团队如今也更专注于将其打造为一个商业产品而不是开源工具。
-
-:::
diff --git a/src/zh/reference/plugin-api.md b/src/zh/reference/plugin-api.md
@@ -17,25 +17,11 @@ icon: fa6-solid:plug
 
 下列 Hooks 会在初始化 App 时处理：
 
-- [插件 API](#插件-api)
-  - [概览](#概览)
-  - [基础配置项](#基础配置项)
-    - [name](#name)
-    - [multiple](#multiple)
-  - [开发 Hooks](#开发-hooks)
-    - [alias](#alias)
-    - [clientConfigFile](#clientconfigfile)
-    - [define](#define)
-    - [extendsBundlerOptions](#extendsbundleroptions)
-    - [extendsMarkdownOptions](#extendsmarkdownoptions)
-    - [extendsMarkdown](#extendsmarkdown)
-    - [extendsPageOptions](#extendspageoptions)
-    - [extendsPage](#extendspage)
-  - [生命周期 Hooks](#生命周期-hooks)
-    - [onInitialized](#oninitialized)
-    - [onPrepared](#onprepared)
-    - [onWatched](#onwatched)
-    - [onGenerated](#ongenerated)
+- [extendsMarkdownOptions](#extendsmarkdownoptions)
+- [extendsMarkdown](#extendsmarkdown)
+- [extendsPageOptions](#extendspageoptions)
+- [extendsPage](#extendspage)
+- [onInitialized](#oninitialized)
 
 下列 Hooks 会在准备文件时处理：