Skip to content

Commit

Permalink
Reduce external integration points (#142)
Browse files Browse the repository at this point in the history 
* Remove MSClarity

* Add npm support to container

* Remove comment capability.

* Add a note for different local theme replacements

* Remove external dependencies
  • Loading branch information
@chrisreddington
chrisreddington authored Jan 28, 2024
1 parent d7c8eca commit 91b6d41
Show file tree
Hide file tree
Showing 13 changed files with 16 additions and 419 deletions.
3 changes: 2 additions & 1 deletion .devcontainer/devcontainer.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,8 @@
"features": {
"ghcr.io/devcontainers/features/hugo:1": {
"extended": true
}
},
"ghcr.io/devcontainers/features/node:1": {}
},

// Use 'forwardPorts' to make a list of ports inside the container available locally.
Expand Down
72 changes: 2 additions & 70 deletions REFERENCE.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -202,28 +202,6 @@ params:
youtube: "CloudWithChris" # Your youtube channel name
# Parameters relating to site features and functionality
features:
# Settings relating to audio players embedded
# within the site.
audio_player:
use: "podscribe" # The optionms are default or podscribe
podscribe:
someconfig: "tbc"
# Settings related to analytics
analytics:
googleAnalytics: "" # Google Analytics ID
microsoftClarity: ""
# Settings related to the comments section
# embedded within the site.
comments:
giscus:
repository: ""
repository_id: ""
category: "Content Discussion"
category_id: "DIC_kwDODmTrrM4B-kuQ"
mapping: "pathname"
reactions_enabled: 1
emit_metadata: 0
theme: "light"
# Settings related to the Social bar at top of site
socialbox: true
# Settings relating to site security. This mainly
Expand All @@ -238,15 +216,6 @@ params:
connectsrc: ""
framesrc: ""
objectsrc: ""
# Privacy options built in to hugo. The hugo docs explain how to configure this to align with GDPR, so please make sure to ensure this is configured as appropriate for your deployment.
# -
# https://gohugo.io/about/hugo-and-gdpr/
privacy:
googleAnalytics:
anonymizeIP: true
disable: false
respectDoNotTrack: true
useSessionStorage: false
# Taxonomies in hugo are used to easily identify content that belongs
# to a given piece of metadata. This is particularly useful for tags,
# or pieces of content that appear in a series. All taxonomies used within
Expand Down Expand Up @@ -479,37 +448,12 @@ The configuration options in this section are focused around giving user flexibi
```yaml
# Parameters relating to site features and functionality
features:
# Settings relating to audio players embedded
# within the site.
audio_player:
use: "podscribe" # The optionms are default or podscribe
podscribe:
someconfig: "tbc"
# Settings related to analytics
analytics:
googleAnalytics: "" # Google Analytics ID
microsoftClarity: ""
# Settings related to the comments section
# embedded within the site.
comments:
giscus:
repository: ""
repository_id: ""
category: "Content Discussion"
category_id: "DIC_kwDODmTrrM4B-kuQ"
mapping: "pathname"
reactions_enabled: 1
emit_metadata: 0
theme: "light"
# Settings related to the Social bar at top of site
socialbox: true
# Settings related to the Social bar at top of site
socialbox: true
```
| Field Name | Required | Description | Example |
|--------------|----------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| audio_player | Yes | Settings related to audio players embedded within the site. Details on subproperties: **use** controls which player is used. Options are default or podscribe. **podscribe** contains a configuration blog which relates to the podscribe configuration. | audio_player: use: "podscribe" # The optionms are default or podscribe podscribe: someconfig: "tbc" |
| analytics | No | Configuration settings to associate your Google Analytics / Microsoft Clarity telemetry. Details on subproperties: **googleAnalytics** is the Tracking ID of your Google Analytics **microsoftClarity** is the tracking code provided in the Setup experience of Microsoft Clarity (e.g. the last string in the Clarity tracking codeblock) | # Settings related to analytics analytics: googleAnalytics: "" # Google Analytics ID microsoftClarity: "" |
| comments | Yes | Configuration settings relating to the comments system that is configured on the site. Details on subproperties: * **giscus** has several subproperties * **repository** is the name as displayed on GitHub, e.g. CloudWithChris/cloudwithchris.com * **repository_id** is the ID of the repository. * **category** is the Category where you would like discussion threads to be posted * **category_id** is the ID of the category noted above * **mapping** is what the GitHub discussion will be titled * **reactions_enabled** - 1 means enabled, 0 means disabled * **emit_metadata** to be referenced via Giscus docs * **theme** - Options are light or dark | # Settings related to the comments section # embedded within the site. comments: giscus: repository: "" repository_id: "" category: "Content Discussion" category_id: "DIC_kwDODmTrrM4B-kuQ" mapping: "pathname" reactions_enabled: 1 emit_metadata: 0 theme: "light" | |
| socialbox | No | True/false - Determines if the social bar is displayed. Defaults to false if unset. | socialbox: true |
#### Security
Expand Down Expand Up @@ -539,18 +483,6 @@ security:
There are a number of configuration settings built-in to Hugo to help meet Privacy / Data Protection Regulations. The configuration shown is an example configuration. You should make your own decisions on what privacy settings are required, using the [Hugo and the GEneral Data Protection Regulation Documentation](https://gohugo.io/about/hugo-and-gdpr/).
```yaml
# Privacy options built in to hugo. The hugo docs explain how to configure this to align with GDPR, so please make sure to ensure this is configured as appropriate for your deployment.
# -
# https://gohugo.io/about/hugo-and-gdpr/
privacy:
googleAnalytics:
anonymizeIP: true
disable: false
respectDoNotTrack: true
useSessionStorage: false
```
### Taxonomy Settings
Taxonomies in hugo are used to easily identify content that belongs to a given piece of metadata. This is particularly useful for tags, or pieces of content that appear in a series. All taxonomies used within the theme are configured below.
Expand Down
Loading

0 comments on commit 91b6d41

Please sign in to comment.