a4ac3a30e0
* docs: translate README to English in homepage * feat(docs): update hero-text in README * docs: add readme_en * feat(docs): add language jump in readme * docs: update readme layout * feat(docs): add CONTRIBUTION_EN and jump link * docs: translate theme introduction * docs: upgrade version to 135 , create 2 file * docs: add icon, fix translation errors in intro, translate quick-start * docs: translate quick start - write * docs: fix jump link in write * docs: translate document in quick start * docs: translate international in quick start * docs: translate deployment in quick start * docs: translate optimize-build in quick start --------- Co-authored-by: pengzhanbo <volodymyr@foxmail.com>
78 lines
2.9 KiB
Markdown
78 lines
2.9 KiB
Markdown
<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_en.md">English</a>
|
||
</p>
|
||
|
||
一个简约的，干净的，容易上手的 vuepress 主题，适用于博客和文档。
|
||
|
||
开箱即用，仅需少量配置即可使用，让您更专注于 内容的创作，更好的表达你的想法，形成你的知识笔记。
|
||
|
||
内置了丰富的强大的功能，旨在让内容更具有表现力。
|
||
|
||
## 特性
|
||
|
||
- 💻 响应式布局，适配不同的屏幕尺寸
|
||
- 📖 博客 & 文档
|
||
- 🔗 自动生成文章永久链接
|
||
- ⚖ 支持多语言
|
||
- 🔑 支持 全站加密、部分加密
|
||
- 👀 支持 搜索、文章评论
|
||
- 👨💻 支持 浅色/深色 主题 （包括代码高亮）
|
||
- 📠 markdown 增强，支持 代码块分组、提示容器、任务列表、数学公式、代码演示、文件树 等
|
||
- 📚 嵌入代码演示，支持 CodePen, JSFiddle, CodeSandbox 等
|
||
- 📊 嵌入图表，支持 chart.js，Echarts，Mermaid，flowchart
|
||
- 🎛 资源嵌入，支持 PDF, bilibili视频，youtube视频、本地视频、音频等
|
||
- 🪞 支持全站水印、部分内容水印
|
||
|
||
## [使用文档](https://theme-plume.vuejs.press)
|
||
|
||
QQ 交流群：[792882761](https://qm.qq.com/q/O3HNy4rxYc)
|
||
|
||
## 案例
|
||
|
||
- [我的个人博客](https://pengzhanbo.cn/)
|
||
|
||
查看 [更多案例](https://theme-plume.vuejs.press/demos/)
|
||
|
||
### 注意
|
||
|
||
本主题基于 `vuepress 2` ，处于 RC 阶段。
|
||
|
||
这意味着功能已趋于稳定，但在未来仍有小概率发生破坏性更改。
|
||
|
||
## 贡献指南
|
||
|
||
查看 [[贡献指南]](/CONTRIBUTING.md) 了解更多
|
||
|
||
## 贡献者
|
||
|
||
感谢所有的贡献者！
|
||
|
||
|
||
|
||
[](https://github.com/pengzhanbo/vuepress-theme-plume/graphs/contributors)
|
||
|
||
## License
|
||
|
||
[MIT](/LICENSE)
|