Skip to content

Commit aa0dd20

Browse files
docs: official blog plugin and theme (#2149)
1 parent 2b25740 commit aa0dd20

File tree

5 files changed

+117
-0
lines changed

5 files changed

+117
-0
lines changed

packages/docs/docs/.vuepress/config.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -171,6 +171,7 @@ function getThemeSidebar (groupA, introductionA) {
171171
'writing-a-theme',
172172
'option-api',
173173
'default-theme-config',
174+
'blog-theme',
174175
'inheritance'
175176
]
176177
}
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
---
2+
title: blog
3+
metaTitle: Blog plugin | VuePress
4+
---
5+
6+
# [@vuepress/plugin-blog](https://github.com/vuepressjs/vuepress-plugin-blog)
7+
8+
## Features
9+
10+
- [**Classification**](https://vuepress-plugin-blog.ulivz.com/guide/getting-started.html#document-classifier):
11+
Powerful classification system lets you quickly classify your posts.
12+
- [**Pagination**](https://vuepress-plugin-blog.ulivz.com/guide/getting-started.html#pagination):
13+
Pagination runs through the entire plugin, and it has never been so simple.
14+
- [**Client APIs**](https://vuepress-plugin-blog.ulivz.com/client-api/): Simple client APIs make it easier for you to write a blog theme.
15+
16+
## Install
17+
18+
We strongly recommend that you read the [Getting Started](https://vuepress-plugin-blog.ulivz.com/guide/getting-started.html) section before using this plugin.
19+
20+
```bash
21+
yarn add -D @vuepress/plugin-blog
22+
# OR npm install -D @vuepress/plugin-blog
23+
```
24+
25+
## Usage
26+
27+
```javascript
28+
module.exports = {
29+
plugins: ['@vuepress/blog']
30+
}
31+
```
32+
33+
Please head [documentation](https://vuepress-theme-blog.ulivz.com/) to see all available options.
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Blog theme
2+
3+
## Sites
4+
5+
- [Documentation](https://vuepress-theme-blog.ulivz.com)
6+
- [Live Example](https://example.vuepress-theme-blog.ulivz.com/)
7+
- [Live Example - ULIVZ’s space](https://ulivz.com/)
8+
- [Live Example - Billyyyyy3320’s space](https://billyyyyy3320.com/)
9+
10+
## Install
11+
12+
```bash
13+
yarn add @vuepress/theme-blog -D
14+
# OR npm install @vuepress/theme-blog -D
15+
```
16+
## Usage
17+
18+
```js
19+
// .vuepress/config.js
20+
module.exports = {
21+
theme: '@vuepress/blog',
22+
themeConfig: {
23+
// Please head documentation to see the available options.
24+
}
25+
}
26+
```
Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
title: blog
3+
metaTitle: 博客插件 | VuePress
4+
---
5+
6+
# [@vuepress/plugin-blog](https://github.com/vuepressjs/vuepress-plugin-blog)
7+
8+
## 功能
9+
10+
- [**分类**](https://vuepress-plugin-blog.ulivz.com/guide/getting-started.html#document-classifier):强大的分类系统让你快速将贴文分类。
11+
- [**分页**](https://vuepress-plugin-blog.ulivz.com/guide/getting-started.html#pagination): 极其简单的开箱及用分页功能。
12+
- [**客戶端 API**](https://vuepress-plugin-blog.ulivz.com/client-api/): 透过客户端API轻松地写一个博客主题。
13+
14+
## 安装
15+
16+
在使用这个插件之前,我们强烈建议你先阅读 [Getting Started](https://vuepress-plugin-blog.ulivz.com/guide/getting-started.html)
17+
18+
```bash
19+
yarn add -D @vuepress/plugin-blog
20+
# OR npm install -D @vuepress/plugin-blog
21+
```
22+
23+
## 使用
24+
25+
```javascript
26+
module.exports = {
27+
plugins: ['@vuepress/blog']
28+
}
29+
```
30+
31+
参考 [文档](https://vuepress-theme-blog.ulivz.com/) 来查看所有可用的选项。
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# 博客主题
2+
3+
## 网站
4+
5+
- [文檔](https://vuepress-theme-blog.ulivz.com)
6+
- [线上范例](https://example.vuepress-theme-blog.ulivz.com/)
7+
- [线上范例 - ULIVZ's space](https://ulivz.com/)
8+
- [线上范例 - Billyyyyy3320's space](https://billyyyyy3320.com/)
9+
10+
## 安装
11+
12+
```bash
13+
yarn add @vuepress/theme-blog -D
14+
# OR npm install @vuepress/theme-blog -D
15+
```
16+
## 使用
17+
18+
```js
19+
// .vuepress/config.js
20+
module.exports = {
21+
theme: '@vuepress/blog',
22+
themeConfig: {
23+
// 请参考文档来查看所有可用的选项。
24+
}
25+
}
26+
```

0 commit comments

Comments
 (0)