Skip to content

JoeyBling/vuepress-plugin-mygitalk

Repository files navigation

vuepress-plugin-mygitalk

.___  ___. ____    ____  _______  __  .___________.    ___       __       __  ___
|   \/   | \   \  /   / /  _____||  | |           |   /   \     |  |     |  |/  /
|  \  /  |  \   \/   / |  |  __  |  | `---|  |----`  /  ^  \    |  |     |  '  /
|  |\/|  |   \_    _/  |  | |_ | |  |     |  |      /  /_\  \   |  |     |    <
|  |  |  |     |  |    |  |__| | |  |     |  |     /  _____  \  |  `----.|  .  \
|__|  |__|     |__|     \______| |__|     |__|    /__/     \__\ |_______||__|\__\

npm package downloads-total downloads-month star fork GitHub Last Commit issues Author VuePress Version vuepress-theme-yilia-plus 博客搭建交流群


欢迎使用和Star支持,如使用过程中碰到问题,可以提出Issue,我会尽力完善

介绍

    VuePress集成Gitalk. | Gitalk plugin for VuePress.

线上预览

预览 ➡️ https://zhousiwei.gitee.io/ibooks

推荐一款VuePress主题

一款简洁优雅的VuePress主题 ➡️ https://github.com/JoeyBling/vuepress-theme-yilia-plus

效果截图

截图

安装

yarn add vuepress-plugin-mygitalk
# or
npm install vuepress-plugin-mygitalk --save

开始使用

引入该插件

在配置文件中引入 vuepress-plugin-mygitalk

查看 官方文档

module.exports = {
  plugins: [
    [
      'vuepress-plugin-mygitalk'
    ],
  ],
}

插件配置

module.exports = {
  plugins: [
    [
      'vuepress-plugin-mygitalk', {
        // 是否启用(关闭请设置为false)(default: true)
        enable: true,
        // 是否开启首页评论(default: true)。是否为首页是通过frontmatter中名为home的配置项来识别的,而非路由
        home: true,
        // Gitalk配置
        gitalk: {
          // GitHub Application Client ID.
          clientID: '',
          // GitHub Application Client Secret.
          clientSecret: '',
          // GitHub repository. 存储评论的 repo
          repo: '',
          // GitHub repository 所有者,可以是个人或者组织。
          owner: '',
          // GitHub repository 的所有者和合作者 (对这个 repository 有写权限的用户)。(不配置默认是owner配置)
          admin: [''],
          // 设置语言(default: zh-CN)
          language: 'zh-CN',
        }
      }
    ],
  ],
}

其他项目支持

捐赠

    如果感觉对您有帮助,请作者喝杯咖啡吧,请注明您的名字或者昵称,方便作者感谢o( ̄︶ ̄)o

微信 支付宝

关于我

LICENSE

LICENSE