admin2/manual_teachbooks
1
0
Fork 0
mirror of https://github.com/TeachBooks/manual.git synced 2026-11-12 22:35:51 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update utterances.md

Browse source
This commit is contained in:
Tom van Woudenberg 2024-12-05 09:36:18 +01:00 • committed by GitHub
parent 89fdeea7b1
commit 473f104149
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 3 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

6
book/basic-features/utterances.md
View file

@ -6,10 +6,10 @@
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:
2. The baseurl is the root url of your book (the part of the url that doesn't change when opening different pages of the book). It needs to be defined in the `_config.yml` so that utteranc.es knows where to redirect users while interacting with the widget:
```
html:
baseurl : "https://<user>.io/<repo>" #Replace this with your own URL
baseurl : "https://<user/organization>.github.io/<repo>" #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.
@ -28,4 +28,4 @@ Below you see an example of this feature!
theme="github-light"
crossorigin="anonymous"
async>
</script>
</script>