Skip to content

Commit bbbca96

Browse files
committed
update README
1 parent 907eb70 commit bbbca96

File tree

2 files changed

+104
-19
lines changed

2 files changed

+104
-19
lines changed

README.md

+24-19
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,14 @@
22
[![valine](https://img.shields.io/badge/valine-1.3.4-blue.svg)](https://valine.js.org/)
33
[![element-ui](https://img.shields.io/badge/element-2.6.1-blue.svg)](http://element-cn.eleme.io/)
44

5-
## vuepress版本为1.x
5+
[中文文档](https://github.com/hirCodd/vuepress-blog/blob/master/README.md)|[English](https://github.com/hirCodd/vuepress-blog/blob/master/README_en.md)
6+
7+
## vuepress版本为1.0.0-alpha.42
8+
9+
## 快速开始
10+
```bash
11+
git clone https://github.com/hirCodd/vuepress-blog.git
12+
```
613
## 运行项目
714

815
yarn install //安装依赖
@@ -22,10 +29,10 @@
2229

2330
> 如果您想用该项目部署您自己的blog,请fork本项目,然后clone到您本地即可更改。如果您懂vue.js,那您可以自己开发一部分插件。
2431
25-
## 功能
32+
## 已完成功能
2633
- [x] Archives
27-
- [ ] Tags Cloud
28-
- [ ] Cate
34+
- [x] Tags Cloud
35+
- [x] Simple Categories
2936

3037
## 评论功能
3138

@@ -39,21 +46,27 @@
3946
[Gitment](https://imsun.github.io/gitment/)
4047

4148

42-
代码已经写好,在.vuepress目录下的enhanceApp.js中,依照网上配置可以很轻松使用Gitment或者Gittalk。
43-
Valine.js的某些bug确实有点烦恼,目前还在修缮中!
49+
代码已经写好,在`.vuepress/theme/components/Comments.vue`中,依照网上配置可以很轻松使用Gitment或者Gittalk。
4450

4551

4652

4753
## 禁止评论
4854
> 很多情况的页面都不想被评论,所以在每篇文档开头设置即可!如下:
49-
55+
```js
5056
---
5157
title: git 进阶操作命令
52-
comments: true or false
58+
comments: true or false // true: 可以评论,false: 禁止评论
59+
post: true //是否作为archives或者tags的列表,true: 作为 false:禁止
60+
tags:
61+
- xxx
62+
date: 2019/03/21 11:24:30
5363
---
54-
true: 可以评论,false: 禁止评论
5564

56-
## 官网文档
65+
if (element.frontmatter.post == true) {} // archives
66+
if (element.frontmatter.post == true && element.frontmatter.tags.includes(tag)) {} // tags
67+
```
68+
69+
## vuePress官网文档
5770

5871
[Vuepress文档](https://vuepress.docschina.org/)
5972

@@ -63,13 +76,5 @@
6376
## 浏览器支持
6477
Most browsers(Firefox,Chrome等)
6578

66-
## vuepress 0.14版本请参看readme0.x.md
67-
68-
## TODO
69-
70-
1. 使用其他方法更新评论组件 或者使用其他较为好用的评论组件
71-
2. 添加categories and tag
72-
3. 跟换其他主题
73-
7479
## LiCENSE
75-
MIT
80+
[MIT](https://github.com/hirCodd/vuepress-blog/blob/master/LICENSE)

README_en.md

+80
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
[![vuepress](https://img.shields.io/badge/vuepress-1.0.0--alpha.42-blue.svg)](https://v1.vuepress.vuejs.org/)
2+
[![valine](https://img.shields.io/badge/valine-1.3.4-blue.svg)](https://valine.js.org/)
3+
[![element-ui](https://img.shields.io/badge/element-2.6.1-blue.svg)](http://element-cn.eleme.io/)
4+
5+
[中文文档](https://github.com/hirCodd/vuepress-blog/blob/master/README.md)|[English](https://github.com/hirCodd/vuepress-blog/blob/master/README_en.md)
6+
7+
## vuepress: 1.0.0-alpha.42
8+
9+
## Quick Start
10+
```bash
11+
git clone https://github.com/hirCodd/vuepress-blog.git
12+
```
13+
## Local Development
14+
15+
yarn install // install lib
16+
yarn dev // run dev
17+
18+
## Local Demo
19+
> If you see next code:
20+
21+
VuePress dev server listening at http://localhost:8080/
22+
23+
> Open Browser, get this addrss: localhost:8080
24+
25+
## Remote Demo
26+
[demo](https://www.finen.top/)
27+
28+
## Develop
29+
30+
> If you want to develop this blog, you can fork or clone this project.
31+
32+
## Function
33+
- [x] Archives
34+
- [x] Tags Cloud
35+
- [x] Simple Categories
36+
37+
## Comments
38+
39+
### Comment1: Valine.js
40+
[Valine.js](https://valine.js.org/)
41+
42+
### Comment2: gittalk
43+
[Gittalk](https://gitalk.github.io/)
44+
45+
### Comment3 gitment
46+
[Gitment](https://imsun.github.io/gitment/)
47+
48+
49+
this code on the directory: `.vuepress/theme/components/Comments.vue`,yan can use gittalk or gitment easily.
50+
51+
52+
53+
## Forbid Comment
54+
> on the xx.md, you can config these properties
55+
```js
56+
---
57+
title: git
58+
comments: true or false
59+
post: true //archives or tags: true
60+
tags:
61+
- xxx
62+
date: 2019/03/21 11:24:30
63+
---
64+
65+
if (element.frontmatter.post == true) {} // archives
66+
if (element.frontmatter.post == true && element.frontmatter.tags.includes(tag)) {} // tags
67+
```
68+
69+
## vuePress-Document
70+
71+
[Vuepress](https://vuepress.docschina.org/)
72+
73+
## Valine.js-Document
74+
[Valine.js](https://valine.js.org/)
75+
76+
## Browser Support
77+
Most browsers(Firefox,Chrome...)
78+
79+
## LiCENSE
80+
[MIT](https://github.com/hirCodd/vuepress-blog/blob/master/LICENSE)

0 commit comments

Comments
 (0)