Skip to content

Commit 91c8011

Browse files
committed
Improve README.md
1 parent c46d791 commit 91c8011

File tree

1 file changed

+35
-0
lines changed

1 file changed

+35
-0
lines changed

README.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,37 @@
11
# vuepress-plugin-alias
22
Vuepress plugin that generates alias pages for proper redirect handling
3+
4+
## Install
5+
6+
* Yarn
7+
8+
```sh
9+
yarn add vuepress-plugin-alias
10+
```
11+
12+
## Usage
13+
14+
### Vuepress v1.x
15+
16+
```js
17+
// .vuepress/config.js
18+
module.exports = {
19+
plugins: [ 'alias' ]
20+
}
21+
```
22+
23+
and in your front-matter add alias to redirect from
24+
25+
```md
26+
---
27+
alias: old-link.html
28+
---
29+
```
30+
or a list of aliases
31+
```md
32+
---
33+
aliases:
34+
- old-link1.html
35+
- old-link2.html
36+
---
37+
```

0 commit comments

Comments
 (0)