docs: update docs

This commit is contained in:
pengzhanbo 2024-04-04 00:37:20 +08:00
parent a590786541
commit 053cabf38c
3 changed files with 38 additions and 17 deletions

View File

@ -21,18 +21,39 @@ export default defineUserConfig({
theme: plumeTheme({
plugins: {
markdownEnhance: {
hint: true,
codetabs: true,
tabs: true,
align: true,
mark: true,
tasklist: true,
attrs: true,
sup: true,
sub: true,
alert: true,
footnote: true,
katex: true,
hint: true, // 提示容器
codetabs: true, // 代码组
tabs: true, // 选项卡
align: true, // 对齐容器
mark: true, // 标记语法
tasklist: true, // 任务列表语法
attrs: true, // 属性语法
sup: true, // 上标语法
sub: true, // 下标语法
alert: true, // GFM 通知语法
footnote: true, // 注脚语法
katex: true, // 数学公式
// 以下可选项在 主题中默认不启用,
// 请在主题中自行配置
// include: true, // Markdown 导入支持
// figure: true, // 启用图片 Figure 支持
// imgLazyload: true, // 使用原生方式懒加载页面图片
// imgMark: true, // 浅色/深色 图片标记
// imgSize: true, // 图片尺寸支持
// obsidianImgSize: true, // obsidian 图片尺寸支持
// mathjax: true, // Math Jax 数学公式 语法支持
// chart: true, // 图表支持
// echarts: true, // ECharts 图表支持
// flowchart: true, // 流程图支持
// markmap: true, // Markmap 图表支持
// stylize: true, // 对行内语法进行样式化以创建代码片段
// playground: true, // 交互演示
// kotlinPlayground: true, // Kotlin 交互演示
// vuePlayground: true, // Vue 交互演示
// sandpack: true, // sandpack 交互演示
// demo: true, // 代码案例
// revealJs: true, // 幻灯片支持
}
}
}),

View File

@ -14,7 +14,7 @@ permalink: /config/basic/
- 详情: 对主题内部使用的插件进行自定义配置。
主题使用的插件默认已进行了配置,大多数情况下您不需要进行任何修改,如果需要使用到细致的定制化,请查阅
[此文档](/vuepress-theme-plume/plugins-config/)
[此文档](/config/plugins/)
### locales
@ -22,7 +22,7 @@ permalink: /config/basic/
- 默认值: `{}`
- 详情: 多语言配置
多语言配置,参考 [此文档](/vuepress-theme-plume/locales/)
多语言配置,参考 [此文档](/config/locales/)
多语言配置支持以下 [Locale](#locale-配置) 所有配置选项

View File

@ -144,10 +144,10 @@ echo '.cache' >> .gitignore
### 步骤 6
**在 `.vuepress/config.{js,ts}` 中配置主题**
**在 `docs/.vuepress/config.{js,ts}` 中配置主题**
::: code-tabs
@tab .vuepress/config.js
@tab docs/.vuepress/config.js
``` ts
import { defineUserConfig } from 'vuepress'
@ -212,4 +212,4 @@ npm run dev
:::
Vuepress 会在 [http://localhost:8080](http://localhost:8080) 。启动一个热重载的开发服务器。当你修改你的 Markdown 文件时,浏览器中的内容也会自动更新。
Vuepress 会在 [http://localhost:8080](http://localhost:8080) 。启动一个热重载的开发服务器。当你修改你的 Markdown 文件时,浏览器中的内容也会自动更新。