Skip to content

Commit

Permalink
docs: ✏️ update readme package
Browse files Browse the repository at this point in the history
  • Loading branch information
huyikai committed Dec 14, 2023
1 parent d1f1c13 commit c0da6dc
Show file tree
Hide file tree
Showing 6 changed files with 12 additions and 149 deletions.
4 changes: 3 additions & 1 deletion README-zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,9 @@

## 使用

目前规划了两种使用方式:1.使用脚手架初始化(推荐),开箱即用。2.在已有的 vitepress 项目中添加依赖 `@huyikai/vitepress-Helper`,并手动修改设置(config.js)和主题(theme)。
目前规划了两种使用方式:
1.使用脚手架初始化(推荐),开箱即用。
2.在已有的 vitepress 项目中添加依赖 `@huyikai/vitepress-Helper`,并手动修改设置(config.js)和主题(theme)。

### 1. CLI

Expand Down
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,10 @@ On the basis of [vitepress](https://vitepress.vuejs.org), optimize the user expe

## Usage

Currently, two usage methods are planned: 1. Using the scaffolding initialization (recommended), you can get started directly. 2. Add the dependency `@huyikai/vitepress-Helper` to an existing vitepress project and manually modify the config and theme.
Currently, two usage methods are planned:

1. Using the scaffolding initialization (recommended), you can get started directly.
2. Add the dependency `@huyikai/vitepress-Helper` to an existing vitepress project and manually modify the config and theme.

### Cli Init

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@
},
"devDependencies": {
"@huyikai/local-cms": "^0.0.1",
"@huyikai/vitepress-helper": "^0.0.6",
"@huyikai/vitepress-helper": "^0.0.7",
"git-cz": "^4.9.0",
"vitepress": "^1.0.0-rc.31",
"vue": "^3.3.9"
Expand Down
124 changes: 0 additions & 124 deletions packages/@huyikai/vitepress-helper/README-zh.md

This file was deleted.

5 changes: 4 additions & 1 deletion packages/@huyikai/vitepress-helper/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,10 @@ On the basis of [vitepress](https://vitepress.vuejs.org), optimize the user expe

## Usage

Currently, two usage methods are planned: 1. Using the scaffolding initialization (recommended), you can get started directly. 2. Add the dependency `@huyikai/vitepress-Helper` to an existing vitepress project and manually modify the config and theme.
Currently, two usage methods are planned:

1. Using the scaffolding initialization (recommended), you can get started directly.
2. Add the dependency `@huyikai/vitepress-Helper` to an existing vitepress project and manually modify the config and theme.

### Cli Init

Expand Down
21 changes: 0 additions & 21 deletions packages/@huyikai/vitepress-helper/license

This file was deleted.

0 comments on commit c0da6dc

Please sign in to comment.