Utterances¶
Utterances is a commenting engine built on top of GitHub issues. It embeds a comment box in your page that users (with a GitHub account) can use to ask questions. These become comments in a GitHub issue in a repository of your choice.
Utterances is activated on this page. You can see the comment box at the bottom of the page’s content. Click the “log in” button and you’ll be able to post comments!
Activate utteranc.es¶
You can activate utteranc.es by adding the following to your conf.py file:
comments_config = {
"utterances": {
"repo": "github-org/github-repo",
"optional": "config",
}
}
Note
You can pass optional extra configuration for utterances. See the utterances documentation for your options.
Next, follow the utteranc.es configuration instructions.
When you build your documentation, pages will now have a comment box at the bottom. If readers log in via GitHub they will be able to post comments that will then map onto issues in your GitHub repository.