Skip to content
This repository was archived by the owner on May 13, 2024. It is now read-only.

Commit 25a7b06

Browse files
committed
chore: readme
1 parent becf789 commit 25a7b06

File tree

1 file changed

+20
-2
lines changed

1 file changed

+20
-2
lines changed

README.md

Lines changed: 20 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,18 @@
22

33
> Official blog plugin for VuePress.
44
5-
Note that this plugin has been deeply integrated into [@vuepress/theme-blog](https://github.com/ulivz/vuepress-theme-blog).
5+
## Features
6+
7+
- [**Classification**](https://vuepress-plugin-blog.ulivz.com/guide/getting-started.html#document-classifier):
8+
Powerful classification system lets you quickly classify your posts.
9+
- [**Pagination**](https://vuepress-plugin-blog.ulivz.com/guide/getting-started.html#pagination):
10+
Pagination runs through the entire plugin, and it has never been so simple.
11+
- [**Client APIs**](https://vuepress-plugin-blog.ulivz.com/client-api/): Simple client APIs make it easier for you to write a blog theme.
612

713
## Install
814

15+
We strongly recommend that you read the [Getting Started](http://localhost:8081/guide/getting-started.html) section before using this plugin.
16+
917
```bash
1018
yarn add -D @vuepress/plugin-blog
1119
# OR npm install -D @vuepress/plugin-blog
@@ -16,10 +24,20 @@ yarn add -D @vuepress/plugin-blog
1624
```javascript
1725
module.exports = {
1826
plugins: ['@vuepress/blog']
19-
// Please head documentation to see the available options.
2027
}
2128
```
2229

30+
Please head [documentation](https://vuepress-theme-blog.ulivz.com/) to see all available options.
31+
32+
33+
## Projects Using `@vuepress/plugin-blog`
34+
35+
- [70-lines-of-vuepress-blog-theme](https://github.com/ulivz/70-lines-of-vuepress-blog-theme): A VuePress Blog Theme implemented in around 70 lines.
36+
- [@vuepress/theme-blog](https://github.com/ulivz/vuepress-theme-blog): Default blog theme for VuePress.
37+
38+
Feel free to add yours here...
39+
40+
2341
## Author
2442

2543
**@vuepress/theme-blog** © [ULIVZ](https://github.com/ulivz), Released under the [MIT](./LICENSE) License.<br>

0 commit comments

Comments
 (0)