Skip to main content

gitalk comment plugin for teedoc

Project description

teedoc-plugin-comments-gitalk

gitalk comment support for teedoc

Create applications first, callback url set page that have gitalk(default doc and blog pages),https://teedoc.github.io/get_started/zh/ for example.

config example:

"teedoc-plugin-comments-gitalk": {
            "from": "pypi",
            "config": {
                "classes": [
                    "type_doc",
                    "type_blog"
                ],
                "env": {
                    "clientID": "*****",
                    "clientSecret": "********",
                    "repo": "teedoc.github.io",
                    "owner": "teedoc",
                    "admin": ["Neutree"]
                }
            }
        }

admin can directly comment, it will automatically create issue and you can create issue manually for one page, and then set issue number in markdown metadata:

---
title: *****
gitalk-number: 2
---

or create label for issue, need Gitalk and one other lable like Demo, like official issue, and set id for page

---
title: *****
id: Demo
---

or

---
title: *****
gitalk-id: Demo
---

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

teedoc-plugin-comments-gitalk-1.5.0.tar.gz (173.5 kB view hashes)

Uploaded Source

Built Distribution

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page