<h1 align="center">vuepress-theme-plume</h1>

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

<p align="center">
  <a href="https://www.npmjs.com/package/vuepress-theme-plume" target="_blank">
    <img src="https://img.shields.io/npm/v/vuepress-theme-plume?color=32A9C3&labelColor=1B3C4A&label=npm" alt="npm version">
  </a>
  <a href="https://www.npmjs.com/package/vuepress-theme-plume" target="_blank">
    <img src="https://img.shields.io/npm/dy/vuepress-theme-plume?color=32A9C3&labelColor=1B3C4A&label=downloads" alt="npm download">
  </a>
  <img src="https://img.shields.io/npm/dependency-version/vuepress-theme-plume/peer/vuepress?color=32A9C3&labelColor=1B3C4A" alt="peer dependency">
  <img src="https://img.shields.io/github/license/pengzhanbo/vuepress-theme-plume?color=32A9C3&labelColor=1B3C4A" alt="github license">
  <br>
  <a href="https://codecov.io/gh/pengzhanbo/vuepress-theme-plume">
    <img src="https://codecov.io/gh/pengzhanbo/vuepress-theme-plume/graph/badge.svg?token=W6KYBX7WO5" alt="codecov">
  </a>
</p>

<p align="center">
<a href="/readme.md">中文</a> | English
</p>

A simple, clean, and easy-to-use VuePress theme for blogs、columns and documentation.

Ready to use out-of-the-box with minimal configuration,
allowing you to focus more on content creation and better express your ideas to form your knowledge notes.

It includes a rich set of powerful features designed to make content more expressive.

## Features

- 💻 Responsive layout, adapts to different screen sizes
- 📖 Collection: you can simultaneously implement blogs, columns, product documentation, technical documentation, knowledge bases, and more.
- 🔗 Automatically generates article permanent links
- ⚖ Supports multiple languages
- 🔑 Supports full-site encryption and partial encryption
- 👀 Supports search and article comments
- 👨‍💻 Supports light/dark themes (including code highlighting)
- 📠 Markdown enhancement, supports, hint containers, task lists, mathematical formulas, code demonstrations, file trees, timeline and more.
- 🧀 Enhanced code blocks, support for grouping, folding, focusing, line highlighting, word highlighting, twoslash, and more.
- 📚 Embedded code demonstrations, supports CodePen, JSFiddle, CodeSandbox, etc.
- 📊 Embedded charts, supports chart.js, Echarts, Mermaid, flowchart，plantUML
- 🎛 Resource embedding, supports PDF, Bilibili videos, YouTube videos, local videos, audio, etc.
- 🪞 Supports full-site watermark and partial content watermark

## [Documentation](https://theme-plume.vuejs.press)

QQ communication group：[792882761](https://qm.qq.com/q/O3HNy4rxYc)

## Examples

- [My Personal Blog](https://pengzhanbo.cn/)

View [more examples](https://theme-plume.vuejs.press/demos/)

### Note

This theme is based on `vuepress 2` and is in the RC stage.

This means that the functionality is relatively stable, but there is still a small probability of breaking changes in the future.

## Contribution Guide

View the [[Contribution Guide]](/CONTRIBUTING_EN.md) for more information

## Contributors

Thank you to all contributors!

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

## License

[MIT](/LICENSE)
