vuepress-theme-plume/theme/README.md

# vuepress-theme-plume

<p align="center">
<img src="https://theme-plume.vuejs.press/plume.svg" width="200px" alt="vuepress=theme-plume" />
</p>

<p align="center">

[![npm version](https://img.shields.io/npm/v/vuepress-theme-plume?color=32A9C3&labelColor=1B3C4A&label=npm)](https://www.npmjs.com/package/vuepress-theme-plume)
[![npm download](https://img.shields.io/npm/dy/vuepress-theme-plume?color=32A9C3&labelColor=1B3C4A&label=downloads)](https://www.npmjs.com/package/vuepress-theme-plume)
![peer dependency](https://img.shields.io/npm/dependency-version/vuepress-theme-plume/peer/vuepress?color=32A9C3&labelColor=1B3C4A)
![GitHub License](https://img.shields.io/github/license/pengzhanbo/vuepress-theme-plume?color=32A9C3&labelColor=1B3C4A)
[![coverage](https://codecov.io/gh/pengzhanbo/vuepress-theme-plume/graph/badge.svg?token=W6KYBX7WO5)](https://codecov.io/gh/pengzhanbo/vuepress-theme-plume)

</p>

一个简约的，干净的，容易上手的 vuepress 主题，适用于博客和文档。

开箱即用，仅需少量配置即可使用，让您更专注于 内容的创作，更好的表达你的想法，形成你的知识笔记。

内置了丰富的强大的功能，旨在让内容更具有表现力。

## Features

- 💻 响应式布局，适配不同的屏幕尺寸
- 📖 博客 & 文档
- 🔗 自动生成文章永久链接
- ⚖  支持多语言
- 👀 支持 搜索、文章评论
- 👨‍💻‍ 支持 浅色/深色 主题 （包括代码高亮）
- 📠 markdown 增强，支持提示容器、任务列表、数学公式、代码演示、文件树、代码树、时间轴 等
- 🧀 代码块增强，支持 分组、折叠、聚焦、 行高亮、词高亮、twoslash 等
- 😀 内置支持 `iconify` 200k+ 图标，支持可选的 `iconfont` / `fontawesome` 图标。
- 📚 嵌入代码演示，支持 CodePen, JSFiddle, CodeSandbox 等
- 📊 嵌入图表，支持 chart.js，Echarts，Mermaid，flowchart, plantUML
- 🎛 资源嵌入，支持 PDF, bilibili视频，youtube视频、本地视频、音频等
- 🪞 支持全站水印、部分内容水印
- 🔑 支持 全站加密、部分加密

## [使用文档](https://theme-plume.vuejs.press)

## 注意

本主题基于 `vuepress 2` ，处于 RC 阶段。

这意味着功能已趋于稳定，但在未来仍有小概率发生破坏性更改。

## 贡献指南

查看 [[贡献指南]](/CONTRIBUTING.md) 了解更多

## 贡献者

感谢所有的贡献者！

![GitHub contributors](https://img.shields.io/github/contributors/pengzhanbo/vuepress-theme-plume?color=32A9C3&labelColor=1B3C4A&logo=contributorcovenant)

[![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")

![Star History Chart](https://api.star-history.com/svg?repos=pengzhanbo/vuepress-theme-plume&type=Date)

## LICENSE

[MIT](https://github.com/pengzhanbo/vuepress-theme-plume/blob/main/LICENSE)