forked from gitea-yuany3721/vuepress-theme-plume

pengzhanbo 411e9dc41d docs: update docs

2024-04-17 12:17:05 +08:00

11 KiB

Raw Blame History

title, author, icon, createTime, permalink

title	author	icon	createTime	permalink
更多	pengzhanbo	ic:outline-auto-fix-high	2024/03/05 16:27:59	/guide/markdown/advance/

iconify 图标

在 Markdown 文件中使用 iconify 的图标。主题虽然提供了 <Iconify /> 组件来支持在 markdown 中使用图标，但是它需要从远程加载图标，可能速度比较慢。

为此，主题提供了另一种可选的方式，以更简单的方式，在 Markdown 中使用图标，并且将图标资源编译到本地静态资源中。

配置

该功能默认不启用，你需要在 theme 配置中启用。

::: code-tabs @tab .vuepress/config.ts

export default defineUserConfig({
  theme: plumeTheme({
    plugins: {
      markdownPower: {
        icons: true,
      },
    }
  })
})

:::

同时，该功能还需要你额外安装 @iconify/json 依赖。

::: code-tabs @tab pnpm

pnpm add @iconify/json

@tab yarn

yarn add @iconify/json

@tab npm

npm install @iconify/json

:::

语法

:[collect:name]:

设置图标大小和颜色

:[collect:name size]:
:[collect:name /color]:
:[collect:name size/color]:

iconify 拥有非常多的图标，这些图标被分组为不同的 collect，每个 collect 都有自己的图标。

你可以从 https://icon-sets.iconify.design/ 中获取 collect 和 name。

示例

输入：

:[ion:logo-markdown]:

输出：

:[ion:logo-markdown]:

该语法为行内语法，因此，你可以在同一行中跟其他 markdown 语法一起使用。

输入：

github: :[tdesign:logo-github-filled]:
修改颜色：:[tdesign:logo-github-filled /#f00]:
修改大小：:[tdesign:logo-github-filled 36px]:
修改大小颜色：:[tdesign:logo-github-filled 36px/#f00]:

输出：

github: :[tdesign:logo-github-filled]: 修改颜色：:[tdesign:logo-github-filled /#f00]: 修改大小：:[tdesign:logo-github-filled 36px]: 修改大小颜色：:[tdesign:logo-github-filled 36px/#f00]:

选项组

让你的 Markdown 文件支持选项卡。

你需要将选项卡包装在 tabs 容器中。

你可以在 tabs 容器中添加一个 id 后缀，该后缀将用作选项卡 id。所有具有相同 id 的选项卡将共享相同的切换事件。

::: tabs#fruit

<!-- 这里，fruit 将用作 id，它是可选的 -->

<!-- 选项卡内容 -->

:::

在这个容器内，你应该使用 @tab 标记来标记和分隔选项卡内容。

在 @tab 标记后，你可以添加文本 :active 默认激活选项卡，之后的文本将被解析为选项卡标题。

::: tabs

@tab 标题 1

<!-- tab 1 内容 -->

@tab 标题 2

<!-- tab 2 内容 -->

@tab:active 标题 3

<!-- tab 3 将会被默认激活 -->

<!-- tab 3 内容 -->

:::

默认情况下，标题将用作选项卡的值，但你可以使用 id 后缀覆盖它。

::: tabs

@tab 标题 1

<!-- 此处，选项卡 1 的标题“标题 1”将用作值。 -->

<!-- tab 1 内容 -->

@tab 标题 2#值 2

<!-- 这里，tab 2 的标题将是 “标题 2”，但它会使用 “值 2” 作为选项卡的值-->

<!-- tab 2 内容 -->

:::

你可以在每个选项卡中使用 Vue 语法和组件，并且你可以访问 value 和 isActive，表示选项卡的绑定值和选项卡是否处于激活状态。

输入：

::: tabs
@tab npm

npm 应该与 Node.js 被一同安装。

@tab pnpm

```sh
corepack enable
corepack use pnpm@8
```

:::

输出：

::: tabs @tab npm

npm 应该与 Node.js 被一同安装。

@tab pnpm

corepack enable
corepack use pnpm@8

:::

示例容器

有时候，你可能需要在内容中补充一些示例，但期望能与其它内容分隔开来呈现。主题支持在 Markdown 文件中添加示例容器。

语法

::: demo-wrapper
添加你的示例
:::

选项

title="xxx"：标题
no-padding：不添加内边距
img: 仅包含图片时使用
height="xxx": 高度

示例

仅包含图片:

::: demo-wrapper img no-padding
![hero](/images/custom-hero.png)
:::

输出： ::: demo-wrapper img no-padding :::

包含 markdown 语法：

::: demo-wrapper title="标题"
### 三级标题

这是示例容器中的内容。
:::

输出： ::: demo-wrapper title="标题"

三级标题

这是示例容器中的内容。 :::

包含 html /vue 代码：

::: demo-wrapper
<h1 class="your-demo-title">这是标题</h1>
<p class="your-demo-paragraph">这是段落</p>

<style>
  .your-demo-title {
    color: red;
  }
  .your-demo-paragraph {
    color: blue;
  }
</style>
:::

输出： ::: demo-wrapper

这是标题

这是段落

:::

can I use

此功能默认不启用，你可以在配置文件中启用它。

::: code-tabs @tab .vuepress/config.ts

export default defineUserConfig({
  theme: plumeTheme({
    plugins: {
      markdownPower: {
        caniuse: true, // [!code highlight]
      },
    }
  })
})

:::

在编写文章时，提供嵌入 can-i-use WEB feature 各平台支持说明的功能。

方便在描述某个 WEB feature 时，能更直观的表述该特性的支持程度。

在你的文章 markdown文件中，使用以下格式：

@[caniuse](feature)

为了方便使用，主题提供了工具支持：caniuse 特性搜索，你可以直接使用该工具帮助生成 markdown 代码。

语法

@[caniuse](feature)
@[caniuse{browser_versions}](feature)
@[caniuse embed_type](feature)
@[caniuse embed_type{browser_versions}](feature)

feature

必填。正确取值请参考 https://caniuse.bitsofco.de/
{browser_versions}

可选。当前特性在多个版本中的支持情况。

默认值为: {-2,-1,1}

格式： {number,number,...} 取值范围为 -5 ~ 3
- 小于0 表示低于当前浏览器版本的支持情况
- 0 表示当前浏览器版本的支持情况
- 大于0 表示高于当前浏览器版本的支持情况
embed_type

可选。资源嵌入的类型。

类型： 'embed' | 'image'

默认值为：'embed'

示例

获取 css 伪类选择器 :dir() 在各个浏览器的支持情况：

@[caniuse](css-matches-pseudo)

效果：

@caniuse

以图片的形式，获取 css 伪类选择器 :dir() 在各个浏览器的支持情况：

@[caniuse image](css-matches-pseudo)

效果：

@caniuse image

获取 css 伪类选择器 :dir() 特定范围浏览器的支持情况：

@[caniuse{-2,-1,1,2,3}](css-matches-pseudo)

效果：

@caniuse{-2,-1,1,2,3}

导入文件

主题支持在 Markdown 文件中导入文件切片。

导入文件默认不启用，你可以通过配置来启用它。

::: code-tabs @tab .vuepress/config.ts

export default defineUserConfig({
  theme: plumeTheme({
    plugins: {
      markdownEnhance: {
        include: true, // [!code highlight]
      },
    }
  })
})

:::

语法

使用  导入文件。

如果要部分导入文件，你可以指定导入的行数:

同时你也可以导入文件区域:

::::tip 文件区域文件区域是 vscode 中的一个概念，区域内容被 #region 和 #endregion 注释包围。

::::

高级

你还可以设置一个对象来自定义包含文件路径和包含行为。

interface IncludeOptions {
  /**
   * 处理 include 文件路径
   *
   * @default (path) => path
   */
  resolvePath?: (path: string, cwd: string | null) => string
  /**
   * 是否深度导入包含的 Markdown 文件
   *
   * @default false
   */
  deep?: boolean
  /**
   * 是否使用 `<!-- @include: xxx -->` 代替 `@include: xxx` 导入文件
   *
   * @default true
   */
  useComment?: boolean
  /**
   * 是否解析包含的 Markdown 文件的里的相对图像路径
   *
   * @default true
   */
  resolveImagePath?: boolean
  /**
   * 是否解析包含的 Markdown 文件的里的文件相对路径
   *
   * @default true
   */
  resolveLinkPath?: boolean
}

例如: 你可以使用 @src 作为源文件夹的别名。

::: code-tabs @tab .vuepress/config.ts

export default defineUserConfig({
  theme: plumeTheme({
    plugins: {
      markdownEnhance: {
        include: {
          resolvePath: (file) => {
            if (file.startsWith('@src'))
              return file.replace('@src', path.resolve(__dirname, '..'))

            return file
          },
        },
      },
    }
  })
})

:::

此外，如果你想将 Markdown 文件直接放在实际文件旁边，但不希望它们呈现为页面，你可以在 VuePress 配置中设置 pagePatterns 选项。有关详细信息，请参阅 pagePatterns。

::: code-tabs @tab .vuepress/config.ts

export default defineUserConfig({
  // 现在任何带有 `.snippet.md` 扩展名的文件都不会呈现为页面
  pagePatterns: ['**/*.md', '!**/*.snippet.md', '!.vuepress', '!node_modules'], // [!code ++]
  theme: plumeTheme({
    plugins: {
      markdownEnhance: {
        include: true,
      },
    }
  })
})

:::

示例

在项目中有一个 foo.snippet.md 文件： :::: code-tabs @tab foo.snippet.md

### 三级标题

这是 foo.snippet.md 文件中的内容。

::: info
提示容器包括的内容
:::

<!-- region snippet -->
这里是被 `<!-- region snippet -->` 包裹的内容。

通过 `<!-- @include: ./foo.snippet.md#snippet -->` 来引入。
<!-- endregion snippet -->

::::

使用  导入文件：

:::: demo-wrapper title="Include by file"

::::

使用  导入文件内的 5 到 7 行：

:::: demo-wrapper title="Include by lines"

::::

使用  导入 snippet 区域

:::: demo-wrapper title="Include by file region"

::::

11 KiB Raw Blame History Unescape Escape

iconify 图标

配置

语法

示例

选项组

示例容器

语法

选项

示例

三级标题

这是标题

can I use

语法

示例

导入文件

语法

高级

示例

11 KiB

Raw Blame History