diff --git a/book/basic-features/utterances.md b/book/basic-features/utterances.md index ade071f..2388ce1 100644 --- a/book/basic-features/utterances.md +++ b/book/basic-features/utterances.md @@ -4,9 +4,14 @@ [Utterances 🔮](https://utteranc.es/) is a lightweight open-source widget which allows you, your colleages and your students to discuss stuff in a blog post in your book. It is build on GitHub issues, so requires a GitHub repository, although the book can be hosted anywhere (so also on GitLab). -The [utterances website](https://utteranc.es/) clearly explains the required steps. One thing to take care of is that with the current setup of the [deploy book workflow on GitHub](../external/deploy-book-workflow/README.md), this widget only works on the primary branch. - -It's advised to use `Issue title contains page pathname`, because that url is most stable. +The [utterances website](https://utteranc.es/) clearly explains the required steps. Three things to take care of are: +1. With the current setup of the [deploy book workflow on GitHub](../external/deploy-book-workflow/README.md), this widget only works on the primary branch. +2. The baseurl needs to be defined in the template: +``` +html: + baseurl : "https://.io/" #Replace this with your own URL +``` +3. It's advised to use `Issue title contains page pathname` as an option on utteranc.es, because that url is most stable. The given script can be added anywhere in your book, just copy the html-script into your `.md`-file or a markdown cell in your `.ipynb`-file. The blogpost is not visible when you do a local build of the book, build it online or use a local python server as shown in {ref}`setup-local-server`.