From f721129a35133984033dcf7eed32b482a1f12276 Mon Sep 17 00:00:00 2001 From: pengzhanbo Date: Sun, 8 May 2022 03:16:26 +0800 Subject: [PATCH] =?UTF-8?q?docs:=20=E8=A1=A5=E5=85=85=20readme=20&=20packa?= =?UTF-8?q?ges.json=20keywords?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- package.json | 9 +++++++++ packages/plugin-baidu-tongji/README.md | 7 ++++++- packages/plugin-caniuse/README.md | 3 ++- packages/plugin-caniuse/package.json | 7 +++++++ packages/plugin-copy-code/README.md | 1 + packages/theme/README.md | 22 ++++++++++++++++++++++ packages/theme/package.json | 10 +++++++++- 7 files changed, 56 insertions(+), 3 deletions(-) diff --git a/package.json b/package.json index cbdd59d1..0acb83e1 100644 --- a/package.json +++ b/package.json @@ -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": { diff --git a/packages/plugin-baidu-tongji/README.md b/packages/plugin-baidu-tongji/README.md index 6ed84194..a3a398b8 100644 --- a/packages/plugin-baidu-tongji/README.md +++ b/packages/plugin-baidu-tongji/README.md @@ -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 + }) ] // ... } diff --git a/packages/plugin-caniuse/README.md b/packages/plugin-caniuse/README.md index b594810f..3fc534bf 100644 --- a/packages/plugin-caniuse/README.md +++ b/packages/plugin-caniuse/README.md @@ -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' }) ] // ... } diff --git a/packages/plugin-caniuse/package.json b/packages/plugin-caniuse/package.json index b3a9a1b3..91ffc426 100644 --- a/packages/plugin-caniuse/package.json +++ b/packages/plugin-caniuse/package.json @@ -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" diff --git a/packages/plugin-copy-code/README.md b/packages/plugin-copy-code/README.md index 4fe2e2e9..4141a4b3 100644 --- a/packages/plugin-copy-code/README.md +++ b/packages/plugin-copy-code/README.md @@ -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: [ diff --git a/packages/theme/README.md b/packages/theme/README.md index 167f5a78..36512beb 100644 --- a/packages/theme/README.md +++ b/packages/theme/README.md @@ -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 + }) +}) +``` diff --git a/packages/theme/package.json b/packages/theme/package.json index fc352d20..e743d95b 100644 --- a/packages/theme/package.json +++ b/packages/theme/package.json @@ -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" },