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

Improve instructions on how to enable comments via Disqus #832

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Improve instructions on how to enable comments via Disqus #832

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
17 changes: 10 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -244,16 +244,19 @@ You can *add* custom metadata to the `<head />` of your layouts by creating a fi

### Enabling comments (via Disqus)

Optionally, if you have a Disqus account, you can tell Jekyll to use it to show a comments section below each post.
1. Create a Disqus site using [this form](https://disqus.com/admin/create/) and take note of the shortname (the unique Disqus URL prefix displayed under the _Website Name_ field).

:warning: `url`, e.g. `https://example.com`, must be set in you config file for Disqus to work.
1. Add the `_includes/disqus_comments.html` file from this repository to your repository `_includes/` folder.

To enable it, after setting the url field, you also need to add the following lines to your Jekyll site:
1. Make the following changes to your `_config.yml` file:

```yaml
disqus:
shortname: my_disqus_shortname
```
```diff
- url: ""
+ url: https://myusername.github.io

+ disqus:
+ shortname: my_disqus_shortname
```

You can find out more about Disqus' shortnames [here](https://help.disqus.com/installation/whats-a-shortname).

Expand Down