https://github.com/u2sb/vuepress-plugin-vssue-global

Vuepress的Vssue全局评论插件
https://github.com/u2sb/vuepress-plugin-vssue-global

Last synced: about 2 months ago
JSON representation

Vuepress的Vssue全局评论插件

• Host: GitHub
• URL: https://github.com/u2sb/vuepress-plugin-vssue-global
• Owner: u2sb
• License: apache-2.0
• Created: 2022-06-16T06:28:32.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2022-06-29T03:11:33.000Z (about 2 years ago)
• Last Synced: 2024-05-29T08:10:26.689Z (4 months ago)
• Language: Vue
• Homepage:
• Size: 17.6 KB
• Stars: 4
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
> 当前版本仅适配 vuepress 1.x

## 演示

- [U2SB](https://www.u2sb.com)

- [xxwhite](https://blog.xxwhite.com)

## 安装

```

yarn add vuepress-plugin-vssue-global

```

## 配置

配置完全继承 [@vssue/vuepress-plugin-vssue](https://vssue.js.org/zh/guide/vuepress.html)，增加配置项如下：

- title: vssue title，支持 ejs 模板

- needComments: 默认是否需要评论区，当配置为 false 时，需文章 frontmatter 添加`comments: true`才会开启评论区。

```js

module.exports = {

  plugins: [

    [

      "vuepress-plugin-vssue-global",

      {

        platform: "github",

        title: "[Comment]<%- frontmatter.title %>",

        needComments: true,

        // 其他的 Vssue 配置

        clientId: "",

        clientSecret: "",

        owner: "",

        repo: "",

      },

    ],

  ],

};

```

## 开启和关闭评论

每篇文章单独控制评论区，需配置 frontmatter

关闭评论区：

```yml

comments: false

```

开启评论区：

```yml

comments: true

```

## 感谢

本插件开发参考了其他同类插件，在此表示感谢

- [@vssue/vuepress-plugin-vssue](https://vssue.js.org/zh/guide/vuepress.html)

- [vuepress-plugin-comment](https://github.com/dongyuanxin/vuepress-plugin-comment)