From 5d149caf22dabf9e5bcd76afd4d231ffabbbf53d Mon Sep 17 00:00:00 2001 From: Xavi Lee Date: Sat, 30 Dec 2023 08:25:46 +0800 Subject: [PATCH] sync with latest --- docs/zh/guide/extending-default-theme.md | 2 +- docs/zh/guide/getting-started.md | 2 +- docs/zh/guide/markdown.md | 13 ++- docs/zh/guide/ssr-compat.md | 4 +- docs/zh/reference/default-theme-home-page.md | 2 +- docs/zh/reference/default-theme-team-page.md | 3 + docs/zh/reference/site-config.md | 84 +------------------- 7 files changed, 16 insertions(+), 94 deletions(-) diff --git a/docs/zh/guide/extending-default-theme.md b/docs/zh/guide/extending-default-theme.md index 3699fe17..7e1e0258 100644 --- a/docs/zh/guide/extending-default-theme.md +++ b/docs/zh/guide/extending-default-theme.md @@ -116,7 +116,7 @@ import DefaultTheme from 'vitepress/theme' export default { extends: DefaultTheme, - async enhanceApp({ app }) { + enhanceApp({ app }) { // register your custom global components app.component('MyGlobalComponent' /* ... */) } diff --git a/docs/zh/guide/getting-started.md b/docs/zh/guide/getting-started.md index e71b0904..44f3689a 100644 --- a/docs/zh/guide/getting-started.md +++ b/docs/zh/guide/getting-started.md @@ -67,7 +67,7 @@ $ npx vitepress init ``` ```sh [pnpm] -$ pnpm dlx vitepress init +$ pnpm vitepress init ``` ```sh [bun] diff --git a/docs/zh/guide/markdown.md b/docs/zh/guide/markdown.md index 670ca440..159c12f4 100644 --- a/docs/zh/guide/markdown.md +++ b/docs/zh/guide/markdown.md @@ -108,7 +108,7 @@ lang: en-US :tada: :100: -这里你可以找到[所有支持的 emoji 列表](https://github.com/markdown-it/markdown-it-emoji/blob/master/lib/data/full.json)。 +这里你可以找到[所有支持的 emoji 列表](https://github.com/markdown-it/markdown-it-emoji/blob/master/lib/data/full.mjs)。 ## 目录表 (TOC) {#table-of-contents} @@ -265,7 +265,7 @@ Wraps in a
## 代码块中的语法高亮 {#syntax-highlighting-in-code-blocks} -VitePress 使用 [Shiki](https://shiki.matsu.io/) 在 Markdown 代码块中使用彩色文本实现语法高亮。Shiki 支持多种编程语言。你需要做的就是将有效的语言别名附加到代码块的开头： +VitePress 使用 [Shikiji](https://github.com/antfu/shikiji) ([Shiki](https://shiki.matsu.io/) 的改进版本) 在 Markdown 代码块中使用彩色文本实现语法高亮。Shiki 支持多种编程语言。你需要做的就是将有效的语言别名附加到代码块的开头： **输入** @@ -305,7 +305,7 @@ export default { ``` -在 Shiki 的代码仓库中，可以找到[合法的编程语言列表](https://github.com/shikijs/shiki/blob/main/docs/languages.md)。 +在 Shikiji 的代码仓库中，可以找到[合法的编程语言列表](https://github.com/antfu/shikiji/blob/main/docs/languages.md)。 还可以全局配置中自定义语法高亮主题。有关详细信息，参见 [`markdown` 选项](../reference/site-config#markdown)得到更多信息。 @@ -856,27 +856,26 @@ $$ x = {-b \pm \sqrt{b^2-4ac} \over 2a} $$ VitePress 使用 [markdown-it](https://github.com/markdown-it/markdown-it) 作为 Markdown 渲染器。上面提到的很多拓展功能都是通过自定义插件实现的。你可以使用 `.vitepress/config.js` 中的 `markdown` 选项来进一步自定义 `markdown-it` 实例。 ```js +import { defineConfig } from 'vitepress' import markdownItAnchor from 'markdown-it-anchor' import markdownItFoo from 'markdown-it-foo' -module.exports = { +export default defineConfig({ markdown: { // options for markdown-it-anchor // https://github.com/valeriangalliat/markdown-it-anchor#usage anchor: { permalink: markdownItAnchor.permalink.headerLink() }, - // options for @mdit-vue/plugin-toc // https://github.com/mdit-vue/mdit-vue/tree/main/packages/plugin-toc#options toc: { level: [1, 2] }, - config: (md) => { // use more markdown-it plugins! md.use(markdownItFoo) } } -} +}) ``` 请查看[配置参考：站点配置](../reference/site-config#markdown)来获取完整的可配置属性列表。 diff --git a/docs/zh/guide/ssr-compat.md b/docs/zh/guide/ssr-compat.md index 43a7190e..904c71e3 100644 --- a/docs/zh/guide/ssr-compat.md +++ b/docs/zh/guide/ssr-compat.md @@ -58,7 +58,7 @@ export default { async enhanceApp({ app }) { if (!import.meta.env.SSR) { const plugin = await import('plugin-that-access-window-on-import') - app.use(plugin) + app.use(plugin.default) } } } @@ -74,7 +74,7 @@ export default { async enhanceApp({ app }) { if (!import.meta.env.SSR) { const plugin = await import('plugin-that-access-window-on-import') - app.use(plugin) + app.use(plugin.default) } } } satisfies Theme diff --git a/docs/zh/reference/default-theme-home-page.md b/docs/zh/reference/default-theme-home-page.md index afcb2f61..c3f2a64c 100644 --- a/docs/zh/reference/default-theme-home-page.md +++ b/docs/zh/reference/default-theme-home-page.md @@ -131,7 +131,7 @@ interface Feature { // Link when clicked on feature component. The link can // be both internal or external. // - // e.g. `guid/reference/default-theme-home-page` or `htttps://example.com` + // e.g. `guide/reference/default-theme-home-page` or `https://example.com` link?: string // Link text to be shown inside feature component. Best diff --git a/docs/zh/reference/default-theme-team-page.md b/docs/zh/reference/default-theme-team-page.md index 06fca209..b1539b8f 100644 --- a/docs/zh/reference/default-theme-team-page.md +++ b/docs/zh/reference/default-theme-team-page.md @@ -212,6 +212,9 @@ interface TeamMember { // URL for the sponsor page for the member. sponsor?: string + + // Text for the sponsor link. Defaults to 'Sponsor'. + actionText?: string } ``` diff --git a/docs/zh/reference/site-config.md b/docs/zh/reference/site-config.md index 3854e0af..b3c62778 100644 --- a/docs/zh/reference/site-config.md +++ b/docs/zh/reference/site-config.md @@ -477,7 +477,7 @@ When set to `true`, the production app will be built in [MPA Mode](../guide/mpa- - key: `markdown` - Type: `MarkdownOption` -配置 Markdown 解析器选项。VitePress 使用 [Markdown-it](https://github.com/markdown-it/markdown-it) 作为解析器，使用 [Shiki](https://shiki.matsu.io/) 来高亮不同语言语法。在此选项中，你可以传递各种 Markdown 相关选项以满足你的需要。 +配置 Markdown 解析器选项。VitePress 使用 [Markdown-it](https://github.com/markdown-it/markdown-it) 作为解析器，使用[Shikiji](https://github.com/antfu/shikiji) ([Shiki](https://shiki.matsu.io/) 的改进版本) 来高亮不同语言语法。在此选项中，你可以传递各种 Markdown 相关选项以满足你的需要。 ```js export default { @@ -485,87 +485,7 @@ export default { } ``` -以下是你可以在此对象中可配置的所有选项： - -```ts -interface MarkdownOptions extends MarkdownIt.Options { - // Custom theme for syntax highlighting. - // You can use an existing theme. - // See: https://github.com/shikijs/shiki/blob/main/docs/themes.md#all-themes - // Or add your own theme. - // See: https://github.com/shikijs/shiki/blob/main/docs/themes.md#loading-theme - theme?: - | Shiki.IThemeRegistration - | { light: Shiki.IThemeRegistration; dark: Shiki.IThemeRegistration } - - // Enable line numbers in code block. - lineNumbers?: boolean - - // Add support for your own languages. - // https://github.com/shikijs/shiki/blob/main/docs/languages.md#supporting-your-own-languages-with-shiki - languages?: Shiki.ILanguageRegistration[] - - // markdown-it-anchor plugin options. - // See: https://github.com/valeriangalliat/markdown-it-anchor#usage - anchor?: anchorPlugin.AnchorOptions - - // markdown-it-attrs plugin options. - // See: https://github.com/arve0/markdown-it-attrs - attrs?: { - leftDelimiter?: string - rightDelimiter?: string - allowedAttributes?: Array - disable?: boolean - } - - // specify default language for syntax highlighter - defaultHighlightLang?: string - - // @mdit-vue/plugin-frontmatter plugin options. - // See: https://github.com/mdit-vue/mdit-vue/tree/main/packages/plugin-frontmatter#options - frontmatter?: FrontmatterPluginOptions - - // @mdit-vue/plugin-headers plugin options. - // See: https://github.com/mdit-vue/mdit-vue/tree/main/packages/plugin-headers#options - headers?: HeadersPluginOptions | boolean - - // @mdit-vue/plugin-sfc plugin options. - // See: https://github.com/mdit-vue/mdit-vue/tree/main/packages/plugin-sfc#options - sfc?: SfcPluginOptions - - // @mdit-vue/plugin-toc plugin options. - // See: https://github.com/mdit-vue/mdit-vue/tree/main/packages/plugin-toc#options - toc?: TocPluginOptions - - // @mdit-vue/plugin-component plugin options. - // See: https://github.com/mdit-vue/mdit-vue/tree/main/packages/plugin-component#options - component?: ComponentPluginOptions - - // Configure the Markdown-it instance. - config?: (md: MarkdownIt) => void - - // Same as `config` but will be applied before all other plugins. - preConfig?: (md: MarkdownIt) => void - - // Disable cache (experimental) - cache?: boolean - - // Math support (experimental) - // You need to install `markdown-it-mathjax3` and set `math` to `true` to enable it. - // You can also pass options to `markdown-it-mathjax3` here. - // See: https://github.com/tani/markdown-it-mathjax3#customization - math?: boolean | any - - // Global custom container titles - container?: { - infoLabel?: string - tipLabel?: string - warningLabel?: string - dangerLabel?: string - detailsLabel?: string - } -} -``` +查看[类型声明和 jsdocs](https://github.com/vuejs/vitepress/blob/main/src/node/markdown/markdown.ts) 以获得所有可配置的选项。 ### vite