Skip to content

Commit b79620c

Browse files
committed
Update documentation
1 parent ad95a4c commit b79620c

2 files changed

Lines changed: 9 additions & 19 deletions

File tree

README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,7 @@ Here are the main files of the template
6868
├── _config.yml # sample configuration
6969
├── _data
7070
| ├── authors.yml # Update the post authors configurations
71+
| ├── comments.yml # Comments configuration (Disqus, Cusdis, Utterances, Giscus)
7172
| ├── language.yml # Localization configuration
7273
| ├── biblio.yml # To create a reference bibliography
7374
| ├── social.yml # Social configurations to share posts (RSS, shares, ...)
@@ -183,12 +184,15 @@ It will use the [Google Tag Manager](https://support.google.com/analytics/answer
183184

184185
### Comments 💬
185186

187+
Type-on-Strap supports multiple comment systems.
188+
Use `_data/comments.yml` for all comment configurations
189+
186190
#### Disqus
187191

188192
If you have a [Disqus](https://disqus.com/) account, you can show a comments section below each post.
189193

190194
To enable Disqus comments, add your [Disqus shortname](https://help.disqus.com/customer/portal/articles/466208)
191-
to your project's `_config.yml` file:
195+
to your project's `_data/comments.yml.yml` file:
192196

193197
```yml
194198
comments:
@@ -200,7 +204,7 @@ comments:
200204
[Cusdis](https://cusdis.com/) is an open-source alternative to Disqus.
201205
You can read more about it in the [documentation](https://cusdis.com/doc#/)
202206

203-
To enable it, set your Cusdis name in `_config.yml`:
207+
To enable it, set your Cusdis name in `_data/comments.yml.yml`:
204208

205209
```yaml
206210
comments:
@@ -213,7 +217,7 @@ comments:
213217
It stores the comments as GitHub issues on a repository for each page.
214218

215219
Install the utterance [app](https://github.com/apps/utterances) to your repo.
216-
After installing, add your info in the `_config.yml`:
220+
After installing, add your info in the `_data/comments.yml.yml`:
217221

218222
```yaml
219223
comments:
@@ -230,7 +234,7 @@ comments:
230234
It stores the comments as GitHub discussions on a repository for each page.
231235
232236
Install the giscus [app](https://github.com/apps/giscus) to your repo.
233-
After installing, add your info in the `_config.yml`:
237+
After installing, add your info in the `_data/comments.yml.yml`:
234238

235239
```yaml
236240
comments:

_config.yml

Lines changed: 1 addition & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -21,28 +21,14 @@ post_navigation: true
2121
color_image: /assets/img/lineart.png # A bit transparent for color posts.
2222

2323
# Features
24-
# More in the _data folder for share buttons, author and language
24+
# More in the _data folder for comments, share buttons, author and language
2525
# For layout customization, go to the "_sass > base" folder, and check "_variables.scss"
2626
katex: true # Enable if using math markup
2727
mermaid: default # Enable mermaid-js for diagrams, use theme: base, forest, dark, default, neutral
2828
google_analytics: # Measurement ID, e.g. "G-00000"
2929
cookie_consent: false # To respect the usage of cookies
3030
color_theme: auto # auto, dark or light
3131

32-
# Comments options
33-
comments:
34-
disqus_shortname: # Your discus shortname for comments
35-
cusdis_app_id: # Your cusdis data-app-id
36-
utterances: # Enable by filling below information. For more info, go to https://utteranc.es
37-
repo: # your public comments repository (e.g. owner/repo)
38-
issue-term: # Issue term (e.g. "comment" consider issues with this word in the title as comments)
39-
giscus: # Enable by filling below information. For more info, go to https://giscus.app
40-
repo: # Your public comments repository (e.g. owner/repo)
41-
repo-id: # Your repo id, go to https://giscus.app to check it
42-
category: # Category to search discussions. When removed, discussions will be searched in all categories.
43-
category-id: # Your category id, go to https://giscus.app to check it
44-
mapping: # Discussion mapping
45-
4632
# PAGINATION
4733
paginate: 5
4834
paginate_path: "/blog/page:num"

0 commit comments

Comments
 (0)