docs: add analytics

LinkSharer · Sep 20, 2024 · eb2e511 · eb2e511
1 parent 09fb5b7
commit eb2e511
Show file tree

Hide file tree

Showing 3 changed files with 25 additions and 12 deletions.
diff --git a/docs/analytics.md b/docs/analytics.md
@@ -0,0 +1,9 @@
+---
+sidebar_position: 5
+---
+
+# Analytics
+
+Analytics are entirely handled by [simpleanalytics.com](https://www.simpleanalytics.com/?referral=rofes).
+
+You can see the analytics for the demo website [here](https://dashboard.simpleanalytics.com/demo.linksharer.js.org?referral=rofes).
diff --git a/docs/configuration.md b/docs/configuration.md
@@ -6,15 +6,16 @@ sidebar_position: 2
 
 Here's a list of available confuguration fields:
 
-| Field    | Type                       | Description                                                 |
-| -------- | -------------------------- | ----------------------------------------------------------- |
-| template | string                     | The url of the CSS template.                                |
-| cname    | string                     | _Optional_. The `CNAME`.                                    |
-| seo      | [SEO](#seo)                | SEO configurations.                                         |
-| user     | [User](#user)              | User configurations.                                        |
-| links    | Array of [Link](#link)     | A list of links/resources.                                  |
-| socials  | Array of [Social](#social) | _Optional_. A list of socials to display after the links.   |
-| credits  | boolean                    | _Optional_. Whether the credits should be displayed or not. |
+| Field     | Type                       | Description                                                                 |
+| --------- | -------------------------- | --------------------------------------------------------------------------- |
+| template  | string                     | The url of the CSS template.                                                |
+| cname     | string                     | _Optional_. The `CNAME`.                                                    |
+| seo       | [SEO](#seo)                | SEO configurations.                                                         |
+| user      | [User](#user)              | User configurations.                                                        |
+| links     | Array of [Link](#link)     | A list of links/resources.                                                  |
+| socials   | Array of [Social](#social) | _Optional_. A list of socials to display after the links.                   |
+| analytics | boolean                    | _Optional_. Whether [analytics](analytics) should be enabled or not. Default's to false. |
+| credits   | boolean                    | _Optional_. Whether the credits should be displayed or not.                 |
 
 ## User
 

diff --git a/docs/templates.md b/docs/templates.md
@@ -21,22 +21,25 @@ Here's a list of standard templates you can use:
 - **minimal-blue**: minimal design based on blue.
 
 ## Custom Templates
-You're welcome to create your custom template, either starting from one of the [available standard templates](#available-standard-templates) or creating one from scratch.
 
+You're welcome to create your custom template, either starting from one of the [available standard templates](#available-standard-templates) or creating one from scratch.
 
 ### Usage
+
 Add the url to the template in the [`template` field](configuration).
 Plase note that all the required css variables must be provided in your the template.
 
 ### Example
+
 ```css title="static/myCustomTemplate.css"
 :root {
-  ...
+  ...;
 }
 ```
+
 ```ts title="user/config.ts"
 const config: Config = {
   template: 'myCustomTemplate.css',
   ...
 }
-```
+```