vuepress-plugin-awesome-gitalk

    0.0.4 • Public • Published

    Vuepress Plugin Awesome Gitalk talk

    GitHub watchers STAR FORK

    npm download jsDelivr hits (npm) jsdelivr ISSUES GitHub closed pull requests COMMIT LANGUAGES npm

    😚 Welcome

    Welcome to the vuepress plugin with gitalk.

    🎮 TL;DR

    ⌨️ How to use it, 👇

    🔨 Usage

    Node
    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

    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
    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

    📝 License

    LICENSE

    Copyright © 2020-present Rain120.

    Install

    npm i vuepress-plugin-awesome-gitalk

    DownloadsWeekly Downloads

    5

    Version

    0.0.4

    License

    MIT

    Unpacked Size

    16.5 kB

    Total Files

    10

    Last publish

    Collaborators

    • rain120