docs: fix typo
This commit is contained in:
parent
896c7e22df
commit
97a5ba20c3
@ -94,7 +94,7 @@ export const enNavbar: ThemeNavItem[] = defineNavbarConfig([
|
||||
{
|
||||
text: `${version}`,
|
||||
icon: 'codicon:versions',
|
||||
badge: '新',
|
||||
badge: 'New',
|
||||
items: [
|
||||
{ text: 'Changelog', link: '/en/changelog/' },
|
||||
{ text: 'Contributing', link: '/en/contributing/' },
|
||||
|
||||
@ -82,7 +82,7 @@ export default defineUserConfig({
|
||||
|
||||
主题提供了 `plume.config.ts` 配置文件,==对该文件的修改支持热更新,无需重启服务=={.tip} ::twemoji:confetti-ball::。
|
||||
|
||||
你可以在其中配置支持热更新的字段,如 `navbar`、`profile` 等。
|
||||
您可以在其中配置支持热更新的字段,如 `navbar`、`profile` 等。
|
||||
|
||||
::: tip
|
||||
这些字段仍可在 VuePress 配置文件的 `theme` 中配置,但主题配置文件的设置最终会合并到主配置中。
|
||||
|
||||
@ -6,7 +6,7 @@ permalink: /config/locales/
|
||||
|
||||
这些选项用于配置与语言相关的文本。
|
||||
|
||||
如果你的站点是以非内置语言支持以外的其他语言提供服务的,你应该为每个语言设置这些选项来提供翻译。
|
||||
如果您的站点是以非内置语言支持以外的其他语言提供服务的,您应该为每个语言设置这些选项来提供翻译。
|
||||
|
||||
## 内置语言支持
|
||||
|
||||
|
||||
@ -11,7 +11,7 @@ permalink: /config/navigation/
|
||||
|
||||
主题默认会自动生成最简单的导航栏配置,仅包括 **首页** 和 **文章列表页** 。
|
||||
|
||||
你也可以自己配置导航栏,覆盖默认的的导航栏配置。
|
||||
您也可以自己配置导航栏,覆盖默认的导航栏配置。
|
||||
|
||||
默认配置如下:
|
||||
|
||||
|
||||
@ -14,8 +14,7 @@ permalink: /config/theme/
|
||||
::: warning 该字段不支持在 [主题配置文件 `plume.config.js`](./intro.md#主题配置文件) 中进行配置。
|
||||
:::
|
||||
|
||||
无以上声明的字段,你可以在 `.vuepress/config.ts` 或者 `.vuepress/plume.config.ts` 的任意一个文件中
|
||||
进行配置,一般情况下建议在 `.vuepress/plume.config.ts` 中进行配置。
|
||||
无以上声明的字段,您可以在 `.vuepress/config.ts` 或者 `.vuepress/plume.config.ts` 的任意一个文件中进行配置,一般情况下建议在 `.vuepress/plume.config.ts` 中进行配置。
|
||||
|
||||
::: warning 已经在一个配置文件中进行配置的字段,尽量不要在另一个配置文件中重复配置
|
||||
:::
|
||||
@ -441,9 +440,9 @@ export default defineUserConfig({
|
||||
|
||||
:::
|
||||
|
||||
[你可以在这里查看 **simple-icons** 所有可用图标](https://icon-sets.iconify.design/simple-icons/){.readmore}
|
||||
[您可以在这里查看 **simple-icons** 所有可用图标](https://icon-sets.iconify.design/simple-icons/){.readmore}
|
||||
|
||||
如果 **Iconify** 无法满足你的需求,可以传入 `{ svg: string, name?: string }`的格式,使用自定义图标,传入 svg 源码字符串,可选 `name` 字段,用于配置 [`navbarSocialInclude`](#navbarsocialinclude)
|
||||
如果 **Iconify** 无法满足您的需求,可以传入 `{ svg: string, name?: string }` 格式使用自定义图标,传入 SVG 源码字符串,可选 `name` 字段用于配置 [`navbarSocialInclude`](#navbarsocialinclude)
|
||||
|
||||
示例:
|
||||
|
||||
|
||||
@ -124,8 +124,8 @@ export default defineUserConfig({
|
||||
'/': {
|
||||
// Chinese collection configuration // [!code focus:4]
|
||||
collections: [
|
||||
{ type: 'post', dir: 'blog', title: '博客' },
|
||||
{ type: 'doc', dir: 'typescript', title: 'TypeScript笔记', sidebar: 'auto' }
|
||||
{ type: 'post', dir: 'blog', title: 'Blog' },
|
||||
{ type: 'doc', dir: 'typescript', title: 'TypeScript Notes', sidebar: 'auto' }
|
||||
],
|
||||
},
|
||||
'/en/': {
|
||||
@ -150,8 +150,8 @@ export default defineThemeConfig({
|
||||
'/': {
|
||||
// Chinese collection configuration // [!code focus:4]
|
||||
collections: [
|
||||
{ type: 'post', dir: 'blog', title: '博客' },
|
||||
{ type: 'doc', dir: 'typescript', title: 'TypeScript笔记', sidebar: 'auto' }
|
||||
{ type: 'post', dir: 'blog', title: 'Blog' },
|
||||
{ type: 'doc', dir: 'typescript', title: 'TypeScript Notes', sidebar: 'auto' }
|
||||
],
|
||||
},
|
||||
'/en/': {
|
||||
|
||||
@ -77,12 +77,12 @@ list:
|
||||
name: pengzhanbo
|
||||
link: https://github.com/pengzhanbo
|
||||
avatar: https://github.com/pengzhanbo.png
|
||||
desc: 即使慢,驰而不息,纵会落后,纵会失败,但必须能够到达他所向的目标。
|
||||
desc: Even if slow, persist without stop; even if falling behind, even if failing, one must be able to reach the goal they are heading towards.
|
||||
-
|
||||
name: pengzhanbo
|
||||
link: https://github.com/pengzhanbo
|
||||
avatar: https://github.com/pengzhanbo.png
|
||||
desc: 即使慢,驰而不息,纵会落后,纵会失败,但必须能够到达他所向的目标。
|
||||
desc: Even if slow, persist without stop; even if falling behind, even if failing, one must be able to reach the goal they are heading towards.
|
||||
socials:
|
||||
-
|
||||
icon: github
|
||||
@ -96,7 +96,7 @@ list:
|
||||
avatar: https://github.com/pengzhanbo.png
|
||||
location: GuangZhou
|
||||
organization: PengZhanBo
|
||||
desc: 即使慢,驰而不息,纵会落后,纵会失败,但必须能够到达他所向的目标。
|
||||
desc: Even if slow, persist without stop; even if falling behind, even if failing, one must be able to reach the goal they are heading towards.
|
||||
socials:
|
||||
-
|
||||
icon: github
|
||||
@ -110,17 +110,17 @@ list:
|
||||
avatar: https://github.com/pengzhanbo.png
|
||||
location: GuangZhou
|
||||
organization: PengZhanBo
|
||||
desc: 即使慢,驰而不息,纵会落后,纵会失败,但必须能够到达他所向的目标。
|
||||
desc: Even if slow, persist without stop; even if falling behind, even if failing, one must be able to reach the goal they are heading towards.
|
||||
groups:
|
||||
-
|
||||
title: 分组 1
|
||||
desc: 自定义颜色
|
||||
title: Group 1
|
||||
desc: Custom colors
|
||||
list:
|
||||
-
|
||||
name: pengzhanbo
|
||||
link: https://github.com/pengzhanbo
|
||||
avatar: https://github.com/pengzhanbo.png
|
||||
desc: 即使慢,驰而不息,纵会落后,纵会失败,但必须能够到达他所向的目标。
|
||||
desc: Even if slow, persist without stop; even if falling behind, even if failing, one must be able to reach the goal they are heading towards.
|
||||
backgroundColor: rgb(255,153,0)
|
||||
color: rgb(255,255,153)
|
||||
nameColor: rgb(255,255,170)
|
||||
@ -135,7 +135,7 @@ groups:
|
||||
name: pengzhanbo
|
||||
link: https://github.com/pengzhanbo
|
||||
avatar: https://github.com/pengzhanbo.png
|
||||
desc: 即使慢,驰而不息,纵会落后,纵会失败,但必须能够到达他所向的目标。
|
||||
desc: Even if slow, persist without stop; even if falling behind, even if failing, one must be able to reach the goal they are heading towards.
|
||||
backgroundColor: rgb(255,102,102)
|
||||
color: rgb(255,204,204)
|
||||
nameColor: rgb(255,238,238)
|
||||
@ -143,22 +143,22 @@ groups:
|
||||
name: pengzhanbo
|
||||
link: https://github.com/pengzhanbo
|
||||
avatar: https://github.com/pengzhanbo.png
|
||||
desc: 即使慢,驰而不息,纵会落后,纵会失败,但必须能够到达他所向的目标。
|
||||
desc: Even if slow, persist without stop; even if falling behind, even if failing, one must be able to reach the goal they are heading towards.
|
||||
backgroundColor: rgb(0,153,204)
|
||||
color: rgb(153,238,255)
|
||||
nameColor: rgb(153,255,255)
|
||||
-
|
||||
title: 分组 2
|
||||
desc: 这里是分组 2 的描述文字
|
||||
title: Group 2
|
||||
desc: Description for Group 2
|
||||
list:
|
||||
-
|
||||
name: pengzhanbo
|
||||
link: https://github.com/pengzhanbo
|
||||
avatar: https://github.com/pengzhanbo.png
|
||||
desc: 即使慢,驰而不息,纵会落后,纵会失败,但必须能够到达他所向的目标。
|
||||
desc: Even if slow, persist without stop; even if falling behind, even if failing, one must be able to reach the goal they are heading towards.
|
||||
-
|
||||
name: pengzhanbo
|
||||
link: https://github.com/pengzhanbo
|
||||
avatar: https://github.com/pengzhanbo.png
|
||||
desc: 即使慢,驰而不息,纵会落后,纵会失败,但必须能够到达他所向的目标。
|
||||
desc: Even if slow, persist without stop; even if falling behind, even if failing, one must be able to reach the goal they are heading towards.
|
||||
---
|
||||
|
||||
@ -86,7 +86,7 @@ Refer to the [ECharts documentation](https://echarts.apache.org/handbook/zh/get-
|
||||
## Advanced
|
||||
|
||||
You can import and use `defineEchartsConfig` in the
|
||||
[client configuration file](https://vuejs.press/zh/guide/configuration.html##使用脚本) to customize ECharts:
|
||||
[client configuration file](https://vuejs.press/guide/configuration.html#client-config-file) to customize ECharts:
|
||||
|
||||
```ts
|
||||
import { defineEchartsConfig } from '@vuepress/plugin-markdown-chart/client'
|
||||
|
||||
@ -132,4 +132,4 @@ It can also be placed within a `<CardGrid>` component.
|
||||
/>
|
||||
</CardGrid>
|
||||
|
||||
[View Photography Works Example](../../../../../blog/1.示例/照片类作品示例.md)
|
||||
[View Photography Works Example](/en/demos/)
|
||||
|
||||
@ -64,7 +64,7 @@ export default defineUserConfig({
|
||||
encrypt: {
|
||||
rules: {
|
||||
// Can be the relative path of an MD file to encrypt that file
|
||||
'前端/基础.md': '123456',
|
||||
'frontend/basics.md': '123456',
|
||||
// Can be a directory path to encrypt all articles under that directory
|
||||
'/notes/vuepress-theme-plume/': '123456',
|
||||
// Can be a request path to encrypt all articles under that path
|
||||
|
||||
@ -159,13 +159,13 @@ Right-aligned content
|
||||
**Input:**
|
||||
|
||||
````md
|
||||
The farthest distance in the world Is not the distance between life and death But you don't know I love you when I stand in front of you.[^footnote1]。
|
||||
The farthest distance in the world Is not the distance between life and death But you don't know I love you when I stand in front of you.[^footnote1].
|
||||
|
||||
[^footnote1]: From India.Rabindranath Tagore **The Farthest Distance in the World**
|
||||
````
|
||||
|
||||
**Output:**
|
||||
|
||||
The farthest distance in the world Is not the distance between life and death But you don't know I love you when I stand in front of you.[^footnote1]。
|
||||
The farthest distance in the world Is not the distance between life and death But you don't know I love you when I stand in front of you.[^footnote1].
|
||||
|
||||
[^footnote1]: From India.Rabindranath Tagore **The Farthest Distance in the World**
|
||||
|
||||
@ -94,7 +94,7 @@ export default defineUserConfig({
|
||||
{
|
||||
type: 'doc',
|
||||
dir: 'guide',
|
||||
title: '指南',
|
||||
title: 'Guide',
|
||||
// autoFrontmatter: true, // Theme built-in configuration
|
||||
autoFrontmatter: {
|
||||
title: true, // Auto-generate title
|
||||
@ -117,7 +117,7 @@ export default defineThemeConfig({
|
||||
{
|
||||
type: 'doc',
|
||||
dir: 'guide',
|
||||
title: '指南',
|
||||
title: 'Guide',
|
||||
// autoFrontmatter: true, // Theme built-in configuration
|
||||
autoFrontmatter: {
|
||||
title: true, // Auto-generate title
|
||||
@ -297,23 +297,23 @@ Example:
|
||||
|
||||
::: code-tree
|
||||
|
||||
```md title="docs/blog/服务.md"
|
||||
```md title="docs/blog/service.md"
|
||||
---
|
||||
title: 服务
|
||||
permalink: /blog/wu-fu/
|
||||
title: Service
|
||||
permalink: /blog/service/
|
||||
---
|
||||
```
|
||||
|
||||
```md title="docs/blog/都城.md"
|
||||
```md title="docs/blog/capital.md"
|
||||
---
|
||||
title: 都城
|
||||
permalink: /blog/dou-cheng/
|
||||
title: Capital
|
||||
permalink: /blog/capital/
|
||||
---
|
||||
```
|
||||
|
||||
:::
|
||||
|
||||
You probably noticed that in the example, the permalink for the `都城.md` file is `/blog/dou-cheng/`,
|
||||
You probably noticed that in the example, the permalink for the `capital.md` file is `/blog/capital/`,
|
||||
which is incorrect. This is because `pinyin-pro`'s default dictionary cannot accurately identify polyphonic
|
||||
characters. If you need a more precise conversion result,you can manually install `@pinyin-pro/data`,
|
||||
and the theme will automatically load this dictionary to improve accuracy.
|
||||
@ -326,9 +326,9 @@ npm i @pinyin-pro/data
|
||||
|
||||
:::
|
||||
|
||||
```md title="docs/blog/都城.md"
|
||||
```md title="docs/blog/capital.md"
|
||||
---
|
||||
title: 都城
|
||||
permalink: /blog/du-cheng/
|
||||
title: Capital
|
||||
permalink: /blog/capital/
|
||||
---
|
||||
```
|
||||
|
||||
@ -760,8 +760,6 @@ Automatically switches to `top` layout on narrow-screen devices to ensure displa
|
||||
|
||||
## Article Metadata
|
||||
|
||||
## 文章元数据
|
||||
|
||||
In the collection, the `meta` option allows you to set the display method of article metadata,
|
||||
This setting will directly affect the display of metadata on both the **article list page** and the **article content page**:
|
||||
|
||||
@ -779,7 +777,7 @@ export default defineUserConfig({
|
||||
{
|
||||
type: 'post',
|
||||
dir: 'blog',
|
||||
title: '博客',
|
||||
title: 'Blog',
|
||||
// [!code hl:11]
|
||||
meta: {
|
||||
tags: true, // Whether to display labels
|
||||
@ -808,7 +806,7 @@ export default defineThemeConfig({
|
||||
{
|
||||
type: 'post',
|
||||
dir: 'blog',
|
||||
title: '博客',
|
||||
title: 'Blog',
|
||||
// [!code hl:11]
|
||||
meta: {
|
||||
tags: true, // Whether to display labels
|
||||
|
||||
@ -13,7 +13,7 @@ whether you are creating a **technical blog**, **personal journal**, **product d
|
||||
**knowledge base**, or **tutorial series**.
|
||||
|
||||
Deep optimizations have been applied to typography and image display,
|
||||
with extensive enhancements specifically for Markdown syntax.This allows you to effortlessly
|
||||
with extensive enhancements specifically for Markdown syntax. This allows you to effortlessly
|
||||
create professional content that is **aesthetically pleasing, highly readable, and expressive**.
|
||||
|
||||
::: details New to VuePress?
|
||||
@ -42,7 +42,7 @@ a more beautiful, clean, and user-friendly reading experience.
|
||||
==content encryption==, and ==article watermarking==.
|
||||
- **Code Presentation**: Support for code block ==grouping==, ==collapsing==, ==focusing==,
|
||||
==line highlighting==, ==diff comparison==, and embedding ==code demos== from platforms like CodePen, JSFiddle, and CodeSandbox.
|
||||
- **Icon System**: Integration with [iconify](https://icon-sets.iconify.d/) providing access to
|
||||
- **Icon System**: Integration with [iconify](https://icon-sets.iconify.design/) providing access to
|
||||
**200,000+** ==icons==, with optional support for `iconfont` / `fontawesome` icon libraries.
|
||||
- **Media Embedding**: Support for ==PDF embedding==, and ==Bilibili/Youtube/Local Video== embedding.
|
||||
- **Chart Rendering**: Integration with multiple ==chart engines== including chart.js, Echarts, Mermaid, Flowchart, Markmap, and PlantUML.
|
||||
|
||||
@ -35,7 +35,7 @@ Page content starts after the second `---`.
|
||||
Frontmatter is a configuration block using
|
||||
[YAML](https://dev.to/paulasantamaria/introduction-to-yaml-125f) format, located at the top of a Markdown file and delimited by `---`.
|
||||
|
||||
It is recommended to read the [Frontmatter Detailed Guide](../../../../4.教程/frontmatter.md) for the complete syntax specification.
|
||||
It is recommended to read the [Frontmatter Detailed Guide](../auto-frontmatter.md) for the complete syntax specification.
|
||||
:::
|
||||
|
||||
## Automatic Frontmatter Generation
|
||||
|
||||
@ -5,19 +5,19 @@ createTime: 2024/04/22 09:44:37
|
||||
permalink: /en/guide/repl/kotlin/
|
||||
---
|
||||
|
||||
## 概述
|
||||
## Overview
|
||||
|
||||
主题提供了 Kotlin 代码演示,支持 在线运行 Kotlin 代码。
|
||||
The theme provides Kotlin code demonstrations, supporting online execution of Kotlin code.
|
||||
|
||||
::: important
|
||||
该功能通过将 代码提交到 服务器 进行 编译并执行,且一次只能提交单个代码文件。
|
||||
This feature works by submitting code to a server for compilation and execution, and only a single code file can be submitted at a time.
|
||||
|
||||
因此,请不要使用此功能 执行 过于复杂的代码,也不要过于频繁的进行执行请求。
|
||||
Therefore, please do not use this feature to execute overly complex code, and avoid making execution requests too frequently.
|
||||
:::
|
||||
|
||||
## 配置
|
||||
## Configuration
|
||||
|
||||
该功能默认不启用,你可以通过配置来启用它。
|
||||
This feature is disabled by default. You can enable it through configuration.
|
||||
|
||||
```ts title=".vuepress/config.ts"
|
||||
export default defineUserConfig({
|
||||
@ -31,39 +31,39 @@ export default defineUserConfig({
|
||||
})
|
||||
```
|
||||
|
||||
## 使用
|
||||
## Usage
|
||||
|
||||
使用 `::: kotlin-repl` 容器语法 将 kotlin 代码块包裹起来。主题会检查代码块并添加执行按钮。
|
||||
Use the `::: kotlin-repl` container syntax to wrap Kotlin code blocks. The theme will inspect the code block and add an execution button.
|
||||
|
||||
### 只读代码演示
|
||||
### Read-Only Code Demo
|
||||
|
||||
kotlin 代码演示默认是只读的,不可编辑。
|
||||
Kotlin code demos are read-only by default and cannot be edited.
|
||||
|
||||
````md
|
||||
::: kotlin-repl title="自定义标题"
|
||||
::: kotlin-repl title="Custom Title"
|
||||
```kotlin
|
||||
// your kotlin code
|
||||
```
|
||||
:::
|
||||
````
|
||||
|
||||
### 可编辑代码演示
|
||||
### Editable Code Demo
|
||||
|
||||
如果需要在线编辑并执行,需要将代码块包裹在 `::: kotlin-repl editable` 容器语法中
|
||||
If you need online editing and execution, wrap the code block in the `::: kotlin-repl editable` container syntax.
|
||||
|
||||
````md
|
||||
::: kotlin-repl editable title="自定义标题"
|
||||
::: kotlin-repl editable title="Custom Title"
|
||||
```kotlin
|
||||
// your kotlin code
|
||||
```
|
||||
:::
|
||||
````
|
||||
|
||||
## 示例
|
||||
## Examples
|
||||
|
||||
### 打印内容
|
||||
### Print Content
|
||||
|
||||
**输入:**
|
||||
**Input:**
|
||||
|
||||
````md
|
||||
::: kotlin-repl
|
||||
@ -78,7 +78,7 @@ fun main(args: Array<String>) {
|
||||
:::
|
||||
````
|
||||
|
||||
**输出:**
|
||||
**Output:**
|
||||
|
||||
::: kotlin-repl
|
||||
|
||||
@ -93,7 +93,7 @@ fun main(args: Array<String>) {
|
||||
|
||||
:::
|
||||
|
||||
### 运算
|
||||
### Computation
|
||||
|
||||
::: kotlin-repl
|
||||
|
||||
@ -109,9 +109,9 @@ fun main(args: Array<String>) {
|
||||
|
||||
:::
|
||||
|
||||
### 可编辑代码演示
|
||||
### Editable Code Demo
|
||||
|
||||
**输入:**
|
||||
**Input:**
|
||||
|
||||
````md
|
||||
::: kotlin-repl editable
|
||||
@ -126,7 +126,7 @@ fun main(args: Array<String>) {
|
||||
:::
|
||||
````
|
||||
|
||||
**输出:**
|
||||
**Output:**
|
||||
|
||||
::: kotlin-repl editable
|
||||
|
||||
|
||||
@ -51,7 +51,7 @@ export default defineUserConfig({
|
||||
:::
|
||||
````
|
||||
|
||||
图标配置请查看 [chart.js] 文档 。
|
||||
图表配置请查看 [chart.js] 文档。
|
||||
|
||||
## 示例
|
||||
|
||||
|
||||
@ -7,7 +7,7 @@ permalink: /guide/code/group/
|
||||
|
||||
## 概述
|
||||
|
||||
代码组(Code Tabs)是 主题 中用于并排展示多个相关代码片段的强大功能。
|
||||
代码组(Code Tabs)是主题中用于并排展示多个相关代码片段的强大功能。
|
||||
通过标签页形式组织代码,您可以清晰对比不同技术栈、配置方案或语言版本的实现差异。
|
||||
|
||||
## 基础语法
|
||||
|
||||
@ -641,7 +641,7 @@ str = 'Hello'
|
||||
你应该能够在控制台中查看到相关的错误信息,然后在错误信息的 `description` 中找到对应的错误码。
|
||||
然后再将错误码添加到 `@errors` 中。
|
||||
|
||||
不用担心变异失败会终止进程,主题会在编译失败时显示错误信息,同时在代码块中输出未编译的代码。
|
||||
不用担心编译失败会终止进程,主题会在编译失败时显示错误信息,同时在代码块中输出未编译的代码。
|
||||
:::
|
||||
|
||||
### `@noErrors`
|
||||
|
||||
@ -7,7 +7,7 @@ permalink: /guide/components/card-masonry/
|
||||
|
||||
## 概述
|
||||
|
||||
瀑布流容器是一个 通用的容器组件,你可以把任何内容放到 `<CardMasonry>` 里面,容器会自动计算每一个 **项** 的高度,
|
||||
瀑布流容器是一个通用的容器组件,你可以把任何内容放到 `<CardMasonry>` 里面,容器会自动计算每一个 **项** 的高度,
|
||||
然后将它们按照瀑布流的方式进行排列。
|
||||
|
||||
::: details 什么是项 ?
|
||||
|
||||
@ -7,7 +7,7 @@ permalink: /guide/components/home-box/
|
||||
|
||||
## 首页布局容器
|
||||
|
||||
自定义首页时,使用 `<HomeBox>` 提供给 区域 的 包装容器。
|
||||
自定义首页时,使用 `<HomeBox>` 提供给区域的包装容器。
|
||||
|
||||
## Props
|
||||
|
||||
|
||||
@ -9,7 +9,7 @@ permalink: /guide/components/image-card/
|
||||
|
||||
使用 `<ImageCard>` 组件在页面中显示图片卡片。
|
||||
|
||||
图片卡片 有别于 markdown 的 普通插入图片方式,它展示与图片相关的更多信息,包括标题、描述、作者、链接等。
|
||||
图片卡片有别于 markdown 的普通插入图片方式,它展示与图片相关的更多信息,包括标题、描述、作者、链接等。
|
||||
适用于如 摄影作品、设计作品、宣传海报 等场景。
|
||||
|
||||
## Props
|
||||
|
||||
@ -12,7 +12,7 @@ import NpmBadgeGroup from 'vuepress-theme-plume/features/NpmBadgeGroup.vue'
|
||||
|
||||
## 概述
|
||||
|
||||
Npm 徽章组件 用于显示 npm 包信息,并提供相关的链接。
|
||||
Npm 徽章组件用于显示 npm 包信息,并提供相关的链接。
|
||||
|
||||
徽章由 <https://shields.io> 提供支持。
|
||||
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
---
|
||||
title: “隐秘”文本
|
||||
title: “隐秘” 文本
|
||||
icon: lets-icons:hide-eye
|
||||
createTime: 2024/08/18 23:02:39
|
||||
permalink: /guide/components/plot/
|
||||
@ -7,7 +7,7 @@ permalink: /guide/components/plot/
|
||||
|
||||
## 概述
|
||||
|
||||
使用 `<Plot>` 组件显示 [“隐秘”文本](../markdown/plot.md) ,能够更灵活的控制行为。
|
||||
使用 `<Plot>` 组件显示 ["隐秘"文本](../markdown/plot.md),能够更灵活地控制行为。
|
||||
|
||||
该组件默认不启用,你需要在 theme 配置中启用。
|
||||
|
||||
|
||||
@ -11,7 +11,7 @@ import RepoCard from 'vuepress-theme-plume/features/RepoCard.vue'
|
||||
|
||||
## 概述
|
||||
|
||||
Repo 卡片组件 用于显示 GitHub / Gitee 仓库信息。
|
||||
Repo 卡片组件用于显示 GitHub / Gitee 仓库信息。
|
||||
|
||||
## 使用
|
||||
|
||||
|
||||
@ -8,8 +8,8 @@ badge: 新
|
||||
|
||||
## 概述
|
||||
|
||||
对于大多数的站点而言,一个 **炫酷好看** 首页首屏,能够更容易的吸引用户停留下来。
|
||||
但实现 **炫酷好看** 往往需要比较复杂的技术成本,以及一些不错的灵感。
|
||||
对于大多数的站点而言,一个 **炫酷好看** 的首页首屏,能够更容易地吸引用户停留下来。
|
||||
但实现 **炫酷好看** 的效果往往需要比较复杂的技术成本,以及一些不错的灵感。
|
||||
|
||||
主题对 **首页** 的 **Hero** 部分,内置了一系列 **炫酷好看** 的背景效果,
|
||||
通过简单的配置即可应用到你的站点首页中:
|
||||
|
||||
@ -320,7 +320,7 @@ const {
|
||||
|
||||
公告板的唯一标识由 `bulletin.id` 配置。
|
||||
|
||||
唯一标识是用于区分公告板,并根据 该表示 决定 `bulletin.lifetime` 的有效期。
|
||||
唯一标识是用于区分公告板,并根据该标识决定 `bulletin.lifetime` 的有效期。
|
||||
|
||||
```ts
|
||||
export default defineUserConfig({
|
||||
|
||||
@ -122,7 +122,7 @@ export default defineUserConfig({
|
||||
|
||||
贡献者信息列表。
|
||||
|
||||
用户在本地 git 服务中配置的 用户名和邮箱 可能与 git 托管服务(如 github、gitlab、gitee)的用户信息不一致。
|
||||
用户在本地 git 服务中配置的用户名和邮箱可能与 git 托管服务(如 github、gitlab、gitee)的用户信息不一致。
|
||||
可以在此预先配置贡献者信息。
|
||||
|
||||
(对于非 github 的其他 git 托管服务,诸如 gitlab、gitee,由于不能通过用户名直接获取头像和用户地址,请在此
|
||||
|
||||
@ -26,16 +26,15 @@ tags:
|
||||
|
||||
内部和外部链接都会被特殊处理。
|
||||
|
||||
主题默认对每个 md 文件自动生成一个新的 链接,并保存在对应的 md 文件的 frontmatter 的 `permalink` 中。
|
||||
你可以随时修改它们。你也可以通过 `theme.autoFrontmatter` 选项来禁用这个功能,这时会恢复为 VuePress 的默认行为。
|
||||
主题默认对每个 Markdown 文件自动生成一个新的链接,并保存在对应的 Markdown 文件的 frontmatter 的 `permalink` 中。您可以随时修改它们。您也可以通过 `theme.autoFrontmatter` 选项来禁用这个功能,这时会恢复为 VuePress 的默认行为。
|
||||
|
||||
### 内部链接
|
||||
|
||||
有三种方式来使用内部链接:
|
||||
|
||||
- 使用 生成的 `permalink` 作为内部链接的目标。
|
||||
- 使用 md 文件的相对路径作为内部链接的目标。
|
||||
- 使用 md 文件的绝对路径作为内部链接的目标, 绝对路径 `/` 表示从 `${sourceDir}` 目录开始。
|
||||
- 使用生成的 `permalink` 作为内部链接的目标。
|
||||
- 使用 Markdown 文件的相对路径作为内部链接的目标。
|
||||
- 使用 Markdown 文件的绝对路径作为内部链接的目标,绝对路径 `/` 表示从 `${sourceDir}` 目录开始。
|
||||
|
||||
```md
|
||||
[Markdown](/guide/markdown/)
|
||||
|
||||
@ -536,9 +536,9 @@ export default defineThemeConfig({
|
||||
|
||||
:::
|
||||
|
||||
[你可以在这里查看 **simple-icons** 所有可用图标](https://icon-sets.iconify.design/simple-icons/){.readmore}
|
||||
[您可以在这里查看 **simple-icons** 所有可用图标](https://icon-sets.iconify.design/simple-icons/){.readmore}
|
||||
|
||||
如果 **Iconify** 无法满足你的需求,可以传入 `{ svg: string, name?: string }`的格式,使用自定义图标,传入 svg 源码字符串。
|
||||
如果 **Iconify** 无法满足您的需求,可以传入 `{ svg: string, name?: string }` 格式使用自定义图标,传入 SVG 源码字符串。
|
||||
|
||||
## 文章封面配置
|
||||
|
||||
@ -938,9 +938,7 @@ config:
|
||||
|
||||
更多自定义配置,请参考 [自定义首页](../custom/home.md)。
|
||||
|
||||
当使用以上两种方式 将首页配置为 文章列表页后,由于主题默认依然会生成 文章列表页,
|
||||
这导致存在了重复功能的页面。为此,你可能需要在 集合配置中,
|
||||
**关闭自动生成博客文章列表页**:
|
||||
当使用以上两种方式将首页配置为文章列表页后,由于主题默认依然会生成文章列表页,这导致存在了重复功能的页面。为此,您可能需要在集合配置中**关闭自动生成博客文章列表页**:
|
||||
|
||||
(还可以重新修改 分类页/标签页/归档页的链接地址)
|
||||
|
||||
|
||||
@ -87,7 +87,7 @@ permalink: /guide/collection/
|
||||
|
||||
:::
|
||||
|
||||
`blog` 目录下的 markdown 文章,在 post 集合中读取为文章列表,并生成列表页、分类页、标签页等页面。
|
||||
`blog` 目录下的 Markdown 文章将被读取为文章列表,并自动生成列表页、分类页、标签页等页面。
|
||||
|
||||
- **完成**
|
||||
::::
|
||||
|
||||
@ -13,7 +13,7 @@ tags:
|
||||
|
||||
侧边栏是文档常见的页面导航方式,可以快速定位到文档内容。
|
||||
|
||||
主题提供了两种方式配置侧边栏,包括:
|
||||
主题提供了两种方式配置侧边栏:
|
||||
|
||||
- 通过主题配置的 `sidebar` 选项配置侧边栏
|
||||
- 在 [类型为 `doc` 的集合](./collection-doc.md) 中配置侧边栏
|
||||
|
||||
@ -8,11 +8,9 @@ tags:
|
||||
- 快速开始
|
||||
---
|
||||
|
||||
VuePress 完整支持 [标准 Markdown 语法](../markdown/basic.md),同时允许通过
|
||||
[YAML](https://dev.to/paulasantamaria/introduction-to-yaml-125f)
|
||||
格式的 Frontmatter 定义页面元数据(如标题、创建时间等)。
|
||||
VuePress 完整支持 [标准 Markdown 语法](../markdown/basic.md),同时允许通过 [YAML](https://dev.to/paulasantamaria/introduction-to-yaml-125f) 格式的 Frontmatter 定义页面元数据(如标题、创建时间等)。
|
||||
|
||||
此外,主题还提供了丰富的 [Markdown 扩展语法](../markdown/extensions.md)。您不仅可以在 Markdown 中直接编写 HTML,还能使用 Vue 组件来增强内容表现力。
|
||||
此外,主题还提供了丰富的 [Markdown 扩展语法](../markdown/extensions.md),您不仅可以在 Markdown 中直接编写 HTML,还能使用 Vue 组件来增强内容表现力。
|
||||
|
||||
## Frontmatter 页面配置
|
||||
|
||||
|
||||
@ -369,8 +369,8 @@ const count = ref(0)
|
||||
:::
|
||||
|
||||
:::::: warning
|
||||
vue demo 容器语法虽然也支持 使用 `.js/ts + css` 的方式来嵌入演示代码,
|
||||
但主题不推荐这样做。因为 样式无法被隔离,这可能导致样式污染。
|
||||
vue demo 容器语法虽然也支持使用 `.js/ts + css` 的方式来嵌入演示代码,
|
||||
但主题不推荐这样做。因为样式无法被隔离,这可能导致样式污染。
|
||||
|
||||
::::: details 参考示例
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user