Skip to content

Commit

Permalink
Add utterances doc to README
Browse files Browse the repository at this point in the history
  • Loading branch information
justint committed Mar 22, 2023
1 parent 985d898 commit 7dd5244
Showing 1 changed file with 20 additions and 0 deletions.
20 changes: 20 additions & 0 deletions README.md
Expand Up @@ -32,6 +32,7 @@ A clean [Zola](https://getzola.org) theme for blogging and projects, forked from
- Smart image embedding shortcode (`{{ img() }}`)
- GitHub repository star/fork counts
- [Open Graph Protocol](https://ogp.me/) tags
- [Utterances](https://utteranc.es/) support
- Social/contact links
- 100% Google Lighthouse score

Expand Down Expand Up @@ -92,6 +93,7 @@ Here are the customizable features of Papaya:
- [Post/project date formats](#postproject-date-formats)
- [Post/project featured images](#postproject-featured-images)
- [Open Graph Protocol locale/profile information](#open-graph-protocol-localeprofile-information)
- [Utterances](#utterances)
- [Social/contact links](#socialcontact-links)

### Project categories
Expand Down Expand Up @@ -415,6 +417,24 @@ gender = "female"
username = "tiliquasp"
```

### Utterances

[Utterances](https://utteranc.es/) is a comments widget built on GitHub issues. When enabled, Papaya can display GitHub issues as comments on your blog posts.

To enable:

1. Follow instructions on the [utterances](https://utteranc.es/) website.

2. Once you're at the "Enable Utterances" step, enter the following keys into your `config.toml`:

```toml
[extra.utterances]
enabled = true
repo = "yourname/yourrepository" # put your repository's short path here
post_map = "pathname"
label = "utterances"
theme = "preferred-color-scheme"

### Social/contact links

In your `config.toml` you can add a `[extra.social]` section to specify your social network/contact accounts. Changing these will update what links appear on your website's footer.
Expand Down

0 comments on commit 7dd5244

Please sign in to comment.