vuepress-plugin-awesome-gitalk

Vuepress Plugin Awesome Gitalk

😚 Welcome

Welcome to the vuepress plugin with gitalk.

#### 🎮 TL;DR

⌨️ How to use it, 👇

#### 🔨 Usage

##### Node

``md
npm install vuepress-plugin-awesome-gitalk --save

// or

yarn add vuepress-plugin-awesome-gitalk
`

Setting with your account

!gitalk-setting-1.png

!gitalk-setting-2.png

.vuepress/config.js

`js
module.exports = {
plugins: [
[
'vuepress-plugin-awesome-gitalk', {
log: true,
pluginName: config.name,
enable: true,
// 挂载节点
root: "gitalk-container",
//最大重试次数
maxRetryCount: 5,
// 默认是检查时间
defaultCheckMinutes: 500,
// 是否开启首页评论
home: false,
// 关闭 Gitalk 评论页面, 需要绝对匹配 fullPath, eg: /docs/
ignorePaths: ['/'],
// gitalk 配置
gitalk: {
clientID: 'your clientID',
clientSecret: 'your clientSecret',
repo: 'your repo name',
owner: 'your owner',
admin: ['your admin'],
language: 'zh-CN',
}
}
],
]
}
`

##### Ignore Paths

`js
module.exports = {
plugins: [
[
'vuepress-plugin-awesome-gitalk', {
ignorePaths: ['ignore/']
}
],
],
}
`

#### 🤝 Contributing !PR

We welcome all contributions. You can submit any ideas as pull requests or as a GitHub issue.

#### 🔗 Links

Docs & Demo

NPM Package

CDN Package

#### 👨‍🏭 Author

> Front-End development engineer, technology stack: React + Typescript + Mobx, also used Vue + Vuex for a while

- Github
- 知乎
- 掘金

#### 📝 License

![LICENSE](https://github.com/Rain120/vuepress-plugin-awesome-gitalk/blob/master/LICENSE)

Copyright © 2020-present Rain120.