p50874913
/
vitepress-theme-linear
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

docs: update

This commit is contained in:
syy11cn 2022-04-28 16:47:01 +08:00
parent 903d422812
commit 268f4e25e5
2 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -32,11 +32,11 @@ pnpm i -D vitepress-theme-linear
### Config Theme ### Config Theme
### Preparation #### Preparation
Refer to official [guide](https://vitepress.vuejs.org/guide/configuration.html#typed-theme-config) to create the `config.ts` file. Refer to official [guide](https://vitepress.vuejs.org/guide/configuration.html#typed-theme-config) to create the `config.ts` file.
### Theme Config #### Theme Config
- `links`: - `links`:
- type: Array; - type: Array;
@ -46,7 +46,7 @@ Refer to official [guide](https://vitepress.vuejs.org/guide/configuration.html#t
- icon: String - path to the icon (public assets should be placed at `public` folder in `docs` folder); - icon: String - path to the icon (public assets should be placed at `public` folder in `docs` folder);
- `posts`: Use `getPosts` function to generate. - `posts`: Use `getPosts` function to generate.
### Sample Configuration #### Sample Configuration
> Don't worry if module `./theme/config` is not found. > Don't worry if module `./theme/config` is not found.

6
docs/index.md
View File

@ -36,11 +36,11 @@ pnpm i -D vitepress-theme-linear
### Config Theme ### Config Theme
### Preparation #### Preparation
Refer to official [guide](https://vitepress.vuejs.org/guide/configuration.html#typed-theme-config) to create the `config.ts` file. Refer to official [guide](https://vitepress.vuejs.org/guide/configuration.html#typed-theme-config) to create the `config.ts` file.
### Theme Config #### Theme Config
- `links`: - `links`:
- type: Array; - type: Array;
@ -50,7 +50,7 @@ Refer to official [guide](https://vitepress.vuejs.org/guide/configuration.html#t
- icon: String - path to the icon (public assets should be placed at `public` folder in `docs` folder); - icon: String - path to the icon (public assets should be placed at `public` folder in `docs` folder);
- `posts`: Use `getPosts` function to generate. - `posts`: Use `getPosts` function to generate.
### Sample Configuration #### Sample Configuration
> Don't worry if module `./theme/config` is not found. > Don't worry if module `./theme/config` is not found.