Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Gitalk docs. #19

Merged
merged 1 commit into from
Mar 4, 2019
Merged

Add Gitalk docs. #19

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions source/docs/third-party-services/comments-and-widgets/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,35 @@ vkontakte_api:
<!-- endtab -->
{% endtabs %}

### Gitalk

Gitalk is a modern comment component based on Github Issue and Preact.

{% note info %}
Gitalk can only use GitHub accounts for comments.
{% endnote %}

1. Click here to sign up for a {% exturl new OAuth Application https://github.com/settings/applications/new %}. Other content can be filled in at will, but be sure to fill in the correct callback URL (usually the domain name corresponding to the comment page). Then you will get a Client ID and a Client secret.
2. Create a repository you want to store Gitalk comments in your GitHub.
3. Set the value `enable` to `true`, add Client ID (`client_id`) and Client secret (`client_secret`) in step 1, add your Github username (`github_id` and `admin_user`) and the created repository name (`repo`) in step 2, and edit other configurations in `gitalk` section in the {% label primary@theme config file %} as following:

```yml next/_config.yml
# Gitalk
# Demo: https://gitalk.github.io
gitalk:
enable: false
github_id: # Github repo owner
repo: # Repository name to store issues
client_id: # Github Application Client ID
client_secret: # Github Application Client Secret
admin_user: # GitHub repo owner and collaborators, only these guys can initialize github issues
distraction_free_mode: true # Facebook-like distraction free mode
# Gitalk's display language depends on user's browser or system environment
# If you want everyone visiting your site to see a uniform language, you can set a force language value
# Available value: en, es-ES, fr, ru, zh-CN, zh-TW
language:
```

### LiveRe

LiveRe is a content platform based on social networking site reviews to help users communicate freely.
Expand Down
5 changes: 3 additions & 2 deletions source/docs/third-party-services/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,12 @@ In any time you can extend needed functions by using third-party services suppor

* [Disqus](/docs/third-party-services/comments-and-widgets/#Disqus)
* [Facebook Comments](/docs/third-party-services/comments-and-widgets/#Facebook-Comments)
* [VKontakte Comments and Likes](/docs/third-party-services/comments-and-widgets/#VKontakte-Comments-and-Likes)
* [Gitalk](/docs/third-party-services/comments-and-widgets/#Gitalk)
* [LiveRe](/docs/third-party-services/comments-and-widgets/#LiveRe)
* [Valine](/docs/third-party-services/comments-and-widgets/#Valine)
* [Gitment](/docs/third-party-services/comments-and-widgets/#Gitment)
* [Changyan](/docs/third-party-services/comments-and-widgets/#Changyan)
* [Valine](/docs/third-party-services/comments-and-widgets/#Valine)
* [VKontakte Comments and Likes](/docs/third-party-services/comments-and-widgets/#VKontakte-Comments-and-Likes)
* [Widgetpack Rating](/docs/third-party-services/comments-and-widgets/#Widgetpack-Rating)

{% note info %}
Expand Down