diff --git a/docs/README.md b/docs/README.md index 2b65c930..1dff992c 100644 --- a/docs/README.md +++ b/docs/README.md @@ -178,6 +178,7 @@ export default defineUserConfig({ 'shylock-wu', 'hrradev', { github: 'TheCoderAlex', name: 'Tang Zifeng' }, + { github: 'HydroGest', name: 'MarkChai'} ]" /> diff --git a/readme.md b/readme.md index d0f0d7b8..dcda9d68 100644 --- a/readme.md +++ b/readme.md @@ -1,6 +1,6 @@
-
+
@@ -14,8 +14,8 @@
-
-
+
+
-
+
@@ -10,6 +10,7 @@ [](https://www.npmjs.com/package/vuepress-theme-plume)   +[](https://codecov.io/gh/pengzhanbo/vuepress-theme-plume)
@@ -34,35 +35,7 @@ - 🎛 资源嵌入,支持 PDF, bilibili视频,youtube视频等 - 🪞 支持全站水印、部分内容水印 -## Install - -``` sh -npm install vuepress@next vuepress-theme-plume -# or -pnpm add vuepress@next vuepress-theme-plume vue -# or -yarn add vuepress@next vuepress-theme-plume -``` - -## Usage - -``` ts -import { defineUserConfig } from 'vuepress' -import { plumeTheme } from 'vuepress-theme-plume' - -export default defineUserConfig({ - // vuepress config... - theme: plumeTheme({ - // theme config... - }) -}) -``` - -### `plumeTheme(options)` - -__options__ : `PlumeThemeOptions` - -[查看 options 详细说明](https://theme-plume.vuejs.press/config/basic/) +## [使用文档](https://theme-plume.vuejs.press) ## 注意 @@ -74,6 +47,12 @@ __options__ : `PlumeThemeOptions` 查看 [[贡献指南]](/CONTRIBUTING.md) 了解更多 +## 贡献者 + +感谢所有的贡献者! + +[](https://github.com/pengzhanbo/vuepress-theme-plume/graphs/contributors) + ## LICENSE [MIT](https://github.com/pengzhanbo/vuepress-theme-plume/blob/main/LICENSE)