Vuepress-comment-plugin

!version

> Support popluar comment plugins in Vuepress, sucn as Gitalk, Valine, Disqus.

- Features
- Usage
- Install
- ⚠️Route object properties
- Use with Gitalk
- Use with Valine
- Hide comment
- Options detail
- Todo

Features

- Support Gitalk, Valine
- Dynamic Import
- Response router change and refresh automatic
- User can use passage's $frontmatter

Usage

$3

With npm:

``bash
npm install --save vuepress-plugin-comment
`

With yarn:

`bash
yarn add vuepress-plugin-comment -D
`

With cnpm:

`bash
cnpm i --save vuepress-plugin-comment
`




$3

Don't use window object directly to get route information.

Plugin has registered correct route information in frontmatter.to object and frontmatter.from object. Their properties are the same as vue-router's route object.

$3

The options is exactly the same as Gitalk configuration.

`javascript
module.exports = {
plugins: [
[
'vuepress-plugin-comment',
{
choosen: 'gitalk',
options: {
clientID: 'GitHub Application Client ID',
clientSecret: 'GitHub Application Client Secret',
repo: 'GitHub repo',
owner: 'GitHub repo owner',
admin: ['GitHub repo owner and collaborators, only these guys can initialize github issues'],
distractionFreeMode: false
}
}
]
]
}
`

If you want to access variables, such as $frontmatter and window, please use EJS syntax.

`javascript
module.exports = {
plugins: [
[
'vuepress-plugin-comment',
{
choosen: 'gitalk',
options: {
id: '<%- frontmatter.commentid || frontmatter.permalink %>',
title: '「Comment」<%- frontmatter.title %>',
body: '<%- frontmatter.title %>：<%-window.location.origin %><%- frontmatter.to.path || window.location.pathname %>',
clientID: 'GitHub Application Client ID',
clientSecret: 'GitHub Application Client Secret',
repo: 'GitHub repo',
owner: 'GitHub repo owner',
admin: ['GitHub repo owner and collaborators, only these guys can initialize github issues'],
distractionFreeMode: false,
}
}
]
]
}
`

Note: Never use callback function in plugin configuration, that will be filtered by vuepress. So I have to support EJS syntax.

$3

The options is exactly the same as Valine configuration.

`javascript
module.exports = {
plugins: [
[
'vuepress-plugin-comment',
{
choosen: 'valine',
options: {
el: '#valine-vuepress-comment',
appId: 'Your own appId',
appKey: 'Your own appKey'
}
}
]
]
}
`

If you want to access variables, such as $frontmatter and window, please use EJS syntax.

`javascript
module.exports = {
plugins: [
[
'vuepress-plugin-comment',
{
choosen: 'valine',
options: {
el: '#valine-vuepress-comment',
appId: 'Your own appId',
appKey: 'Your own appKey',
path: '<%- frontmatter.commentid || frontmatter.permalink %>'
}
}
]
]
}
`

$3

If you want to hide comment plugin in specified page, set $frontmatter.comment or $frontmatter.comments to false.

For example:

`yml
---
comment: false


comments: false


---
`

Comment won't appear in the page of this passage.

Options Detail

- choosen string

Required.

- options object

Required. The options of choosen comment plugin.

- container string

Optional, default as 'main.page'`. The dom selector that contains choosen comment plugin.

Todo

- Support Disqus
- 中文说明