marcel
/
congo
mirror of https://github.com/jpanther/congo.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs: add plausible analytics

pull/584/head
Dejavu Moe 2023-06-16 11:42:32 +08:00
parent cc38c6ed78
commit bff55c09b1
No known key found for this signature in database
GPG Key ID: 8422222222222222
2 changed files with 17 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
exampleSite/content/docs/configuration/index.md
View File

@ -170,6 +170,10 @@ Many of the article defaults here can be overridden on a per article basis by sp
|`taxonomy.showTermCount`|`true`|Whether or not the number of articles within a taxonomy term is displayed on the taxonomy listing.|
|`fathomAnalytics.site`|_Not set_|The site code generated by Fathom Analytics for the website. Refer to the [Analytics docs]({{< ref "partials#analytics" >}}) for more details.|
|`fathomAnalytics.domain`|_Not set_|If using a custom domain with Fathom Analytics, provide it here to serve `script.js` from the custom domain.|
|`plausible.enable`|`false`|Whether to enable Plausible analysis, set `true` to enable.|
|`plausible.domain`|_Not set_|Enter the domain name of the website you want to track. Refer to the [Analytics docs]({{< ref "partials#analytics" >}}) for more details.|
|`plausible.event`|_Not set_|Plausible api event proxy URL. Refer to [Using a proxy for analytics](https://plausible.io/docs/proxy/introduction) for more details.|
|`plausible.script`|_Not set_|Plausible analysis script proxy URL. Refer to [Using a proxy for analytics](https://plausible.io/docs/proxy/introduction) for more details.|
|`verification.google`|_Not set_|The site verification string provided by Google to be included in the site metadata.|
|`verification.bing`|_Not set_|The site verification string provided by Bing to be included in the site metadata.|
|`verification.pinterest`|_Not set_|The site verification string provided by Pinterest to be included in the site metadata.|

13
exampleSite/content/docs/partials/index.md
View File

@ -24,6 +24,19 @@ To enable Fathom Analytics support, simply provide your Fathom site code in the
domain = "llama.yoursite.com"
```
### Plausible Analytics
To enable Plausible analytics support, simply set `plausible.enable` to `true` in the `config/_default/params.toml` file, and then provide your Plausible site `domain`. If you are using a self-hosted Plausible, or wish to use [proxied analytics](https://plausible.io/docs/proxy/introduction) scripts and event API router, you can also provide additional `event` and `script` configuration values. If you do not provide these two values, the script will load directly with Plausible's default.
```toml
# config/_default/params.toml
[plausible]
enable = true
domain = "blog.yoursite.com"
event = "https://stats.dejavu.moe/blog"
script = "https://stats.dejavu.moe/react.min.js"
### Google Analytics
Google Analytics support is provided through the internal Hugo partial. Simply provide the `googleAnalytics` key in the `config/_default/config.toml` file and the script will be added automatically.