From 8bfe995a20599225a03b9b98245f104978abeb8d Mon Sep 17 00:00:00 2001 From: pengzhanbo Date: Fri, 16 May 2025 13:07:18 +0800 Subject: [PATCH] docs: update readme --- docs/notes/theme/guide/quick-start/intro.md | 6 ++++-- readme.md | 5 +++-- theme/README.md | 12 ++++++++---- 3 files changed, 15 insertions(+), 8 deletions(-) diff --git a/docs/notes/theme/guide/quick-start/intro.md b/docs/notes/theme/guide/quick-start/intro.md index 54907eaf..0d6c7b54 100644 --- a/docs/notes/theme/guide/quick-start/intro.md +++ b/docs/notes/theme/guide/quick-start/intro.md @@ -21,6 +21,8 @@ VuePress 是一个 [静态站点生成器](https://en.wikipedia.org/wiki/Static_ 简而言之，VuePress 获取用 Markdown 编写的内容，对其应用主题，并生成可以轻松部署到任何地方的静态 HTML 页面。 ::: +[前往 **VuePress 官网** 了解更多](https://v2.vuepress.vuejs.org/zh/){.read-more} + ## 优势 与 vuepress 默认主题相比： @@ -40,13 +42,13 @@ VuePress 是一个 [静态站点生成器](https://en.wikipedia.org/wiki/Static_ - 可对 ==代码块== 进行 分组、折叠、聚焦、行高亮、差异对比 等， 支持嵌入 CodePen、JSFiddle、CodeSandbox 等作为 ==代码演示==； -- 内置支持 [iconify](https://icon-sets.iconify.design/) **200k+** ==图标==； +- 内置支持 [iconify](https://icon-sets.iconify.design/) **200k+** ==图标==，还支持可选的 `iconfont` / `fontawesome` 图标； - 支持 ==嵌入 PDF==、==嵌入 Bilibili /Youtube / 本地 视频==； - 支持 chart.js、Echarts、Mermaid、Flowchart、Markmap、PlantUML 等多种可选的 ==图表== ； -- 灵活的 markdown 容器语法，支持 ==提示容器==、==文件树==、==示例容器==、==卡片容器==、==瀑布流容器== 等； +- 灵活的 markdown 容器语法，支持 ==提示容器==、==文件树==、==代码树==、==卡片容器==、==瀑布流容器== 等； - 支持 ==布局插槽==、==组件覆写== ==自定义样式== 等，你可以灵活地扩展组件，实现 个性化的 布局。 diff --git a/readme.md b/readme.md index 68921840..3e8d79bc 100644 --- a/readme.md +++ b/readme.md @@ -35,15 +35,16 @@ - 📖 博客 & 文档 - 🔗 自动生成文章永久链接 - ⚖ 支持多语言 -- 🔑 支持 全站加密、部分加密 - 👀 支持 搜索、文章评论 - 👨‍💻‍ 支持 浅色/深色 主题 （包括代码高亮） -- 📠 markdown 增强，支持提示容器、任务列表、数学公式、代码演示、文件树、时间轴 等 +- 📠 markdown 增强，支持提示容器、任务列表、数学公式、代码演示、文件树、代码树、时间轴 等 - 🧀 代码块增强，支持 分组、折叠、聚焦、 行高亮、词高亮、twoslash 等 +- 😀 内置支持 `iconify` 200k+ 图标，支持可选的 `iconfont` / `fontawesome` 图标。 - 📚 嵌入代码演示，支持 CodePen, JSFiddle, CodeSandbox 等 - 📊 嵌入图表，支持 chart.js，Echarts，Mermaid，flowchart, plantUML - 🎛 资源嵌入，支持 PDF, bilibili视频，youtube视频、本地视频、音频等 - 🪞 支持全站水印、部分内容水印 +- 🔑 支持 全站加密、部分加密 ## [使用文档](https://theme-plume.vuejs.press) diff --git a/theme/README.md b/theme/README.md index bab85c5a..ab1407a3 100644 --- a/theme/README.md +++ b/theme/README.md @@ -26,14 +26,16 @@ - 📖 博客 & 文档 - 🔗 自动生成文章永久链接 - ⚖ 支持多语言 -- 🔑 支持 全站加密、部分加密 - 👀 支持 搜索、文章评论 - 👨‍💻‍ 支持 浅色/深色 主题 （包括代码高亮） -- 📠 markdown 增强，支持 代码块分组、提示容器、任务列表、数学公式、代码演示 等 +- 📠 markdown 增强，支持提示容器、任务列表、数学公式、代码演示、文件树、代码树、时间轴 等 +- 🧀 代码块增强，支持 分组、折叠、聚焦、 行高亮、词高亮、twoslash 等 +- 😀 内置支持 `iconify` 200k+ 图标，支持可选的 `iconfont` / `fontawesome` 图标。 - 📚 嵌入代码演示，支持 CodePen, JSFiddle, CodeSandbox 等 -- 📊 嵌入图表，支持 chart.js，Echarts，Mermaid，flowchart -- 🎛 资源嵌入，支持 PDF, bilibili视频，youtube视频等 +- 📊 嵌入图表，支持 chart.js，Echarts，Mermaid，flowchart, plantUML +- 🎛 资源嵌入，支持 PDF, bilibili视频，youtube视频、本地视频、音频等 - 🪞 支持全站水印、部分内容水印 +- 🔑 支持 全站加密、部分加密 ## [使用文档](https://theme-plume.vuejs.press) @@ -55,6 +57,8 @@ [![contributors](https://contrib.rocks/image?repo=pengzhanbo/vuepress-theme-plume)](https://github.com/pengzhanbo/vuepress-theme-plume/graphs/contributors) +![Repo beats](https://repobeats.axiom.co/api/embed/b3e16e8802010e72e933f64864a8047e3163e927.svg "Repo Beats analytics image") + ## LICENSE [MIT](https://github.com/pengzhanbo/vuepress-theme-plume/blob/main/LICENSE)