docs: 补充 readme & packages.json keywords

This commit is contained in:
pengzhanbo 2022-05-08 03:16:26 +08:00
parent b943557671
commit f721129a35
7 changed files with 56 additions and 3 deletions

View File

@ -2,6 +2,15 @@
"name": "vuepress-theme-plume",
"version": "1.0.0-beta.30",
"private": true,
"keywords": [
"vuepress",
"vuepress-next",
"Theme",
"vuepress theme",
"vuepress-theme",
"theme-plume",
"vuepress-theme-plume"
],
"license": "MIT",
"author": "pengzhanbo",
"scripts": {

View File

@ -1,5 +1,7 @@
# `@vuepress-plume/vuepress-plugin-baidu-tongji`
在vuepress中接入百度统计
## Install
```
yarn add @vuepress-plume/vuepress-plugin-baidu-tongji
@ -7,10 +9,13 @@ yarn add @vuepress-plume/vuepress-plugin-baidu-tongji
## Usage
``` js
// .vuepress/config.js
const { baiduTongjiPlugin } = require('@vuepress-plume/vuepress-plugin-baidu-tongji')
module.exports = {
//...
plugins: [
baiduTongjiPlugin()
baiduTongjiPlugin({
key: '', // 百度统计使用的 key
})
]
// ...
}

View File

@ -8,10 +8,11 @@ yarn add @vuepress-plume/vuepress-plugin-caniuse
## Usage
``` js
// .vuepress/config.js
const { caniusePlugin } = require('@vuepress-plume/vuepress-plugin-caniuse')
module.exports = {
//...
plugins: [
['@vuepress-plume/vuepress-plugin-caniuse', { mode: 'embed' }]
caniusePlugin({ mode: 'embed' })
]
// ...
}

View File

@ -2,6 +2,13 @@
"name": "@vuepress-plume/vuepress-plugin-caniuse",
"version": "1.0.0-beta.30",
"description": "The Plugin for VuePres 2, Support Can-I-Use feature",
"keywords": [
"VuePress",
"plugin",
"vuepress-plugin",
"can-i-use",
"caniuse"
],
"homepage": "https://github.com/pengzhanbo/vuepress-theme-plume#readme",
"bugs": {
"url": "https://github.com/pengzhanbo/vuepress-theme-plume/issues"

View File

@ -7,6 +7,7 @@ yarn add @vuepress-plume/vuepress-plugin-copy-code
## Usage
``` js
// .vuepress/config.js
const { copyCodePlugin } = require('@vuepress-plume/vuepress-plugin-copy-code')
module.exports = {
//...
plugins: [

View File

@ -3,3 +3,25 @@
一款基于 VuePress@2 的博客皮肤。
[查看使用文档](https://pengzhanbo.cn/note/vuepress-theme-plume)
## Install
``` sh
# use yarn
yarn add @vuepress-plume/vuepress-theme-plume
# or npm
npm i @vuepress-plume/vuepress-theme-plume
```
## Usage
``` js
// .vuepress/config.ts
import { defineUserConfig } from 'vuepress'
import { themePlume } from '@vuepress-plume/vuepress-theme-plume'
export default defineUserConfig({
theme: themePlume({
// theme config
})
})
```

View File

@ -2,7 +2,15 @@
"name": "@vuepress-plume/vuepress-theme-plume",
"version": "1.0.0-beta.30",
"description": "A Blog Theme for VuePress 2.0",
"homepage": "https://github.com/pengzhanbo/vuepress-theme-plume#readme",
"keywords": [
"VuePress",
"Theme",
"plume",
"vuepress-theme",
"vuepress-theme-plume",
"theme-plume"
],
"homepage": "https://pengzhanbo.cn/note/vuepress-theme-plume",
"bugs": {
"url": "https://github.com/pengzhanbo/vuepress-theme-plume/issues"
},