Adds Ethical Ads

.stylelintrc.json

@@ -9,6 +9,7 @@
     "alpha-value-notation": "number",
     "selector-class-pattern": null,
     "media-feature-range-notation": null,
+    "scss/no-global-function-names": null,
     "at-rule-no-unknown": [
       true,
       {

assets/scss/components/_ads.scss

@@ -1,3 +1,70 @@
+// Ethical Ads
+[data-ea-type="image"].loaded {
+  margin: 1rem 0 2.25rem;
+}
+
+[data-ea-type="text"].loaded {
+  margin: 3rem 0;
+}
+
+/*
+[data-ea-publisher].loaded, [data-ea-type].loaded {
+  font-family: inherit !important;
+}
+*/
+
+.home [data-ea-publisher].loaded {
+  display: none;
+  z-index: 100;
+  position: fixed;
+  right: 1.25rem;
+  bottom: 1.25rem;
+  margin: 0;
+
+  @include media-breakpoint-up(lg) {
+    display: flex;
+  }
+}
+
+[data-ea-publisher].loaded .ea-content, [data-ea-type].loaded .ea-content {
+  background-color: var(--bs-body-bg) !important;
+  border: 1px solid #e9ecef !important;
+  color: $body-color !important;
+}
+
+[data-ea-publisher].loaded .ea-content a:link, [data-ea-type].loaded .ea-content a:link {
+  color: $body-color !important;
+}
+
+[data-ea-publisher].loaded .ea-content a strong, [data-ea-publisher].loaded .ea-content a b, [data-ea-type].loaded .ea-content a strong, [data-ea-type].loaded .ea-content a b {
+  color: $primary !important;
+}
+
+[data-ea-publisher].loaded .ea-callout a:link, [data-ea-type].loaded .ea-callout a:link {
+  color: var(--bs-secondary-color) !important
+}
+
+@include color-mode(dark) {
+  [data-ea-publisher].loaded .ea-content, [data-ea-type].loaded .ea-content {
+    background-color: $body-bg-dark !important;
+    border: 1px solid var(--sl-color-gray-5) !important;
+    color: $body-color-dark !important;
+  }
+
+  [data-ea-publisher].loaded .ea-content a:link, [data-ea-type].loaded .ea-content a:link {
+    color: $body-color-dark !important;
+  }
+
+  [data-ea-publisher].loaded .ea-content a strong, [data-ea-publisher].loaded .ea-content a b, [data-ea-type].loaded .ea-content a strong, [data-ea-type].loaded .ea-content a b {
+    color: $link-color-dark !important;
+  }
+
+  [data-ea-publisher].loaded .ea-callout a:link, [data-ea-type].loaded .ea-callout a:link {
+    color: darken($body-color-dark, 7.5%) !important
+  }
+}
+
+// Carbon Ads
 #carbonads {
   display: block;
   overflow: hidden;

config/_default/params.toml

@@ -17,7 +17,8 @@ footer = "Brought to you by <a class=\"text-muted\" href=\"https://gethyas.com/\
 
 # Add-ons
 [add_ons]
-  carbonAds = true # false (default) or true
+  carbonAds = false # false (default) or true
+  ethicalAds = true # false (default) or true
   docSearch = true # false (default) or true
   plausibleDomain = "getdoks.org" # "example.com" (default)
   keila = false # false (default) or true

config/postcss.config.js

@@ -31,6 +31,8 @@ module.exports = {
         'id',
         'size',
         'type',
+        'data-ea-type',
+        'data-ea-publisher',
       ],
       safelist: [
         'active',

config/production/hugo.toml

@@ -1,2 +1,2 @@
 # Overrides for production environment
-baseurl = "https://getdoks.org/"
+# baseurl = "https://getdoks.org/"

hugo_stats.json

@@ -88,6 +88,7 @@
       "border",
       "border-0",
       "border-top",
+      "bordered",
       "btn",
       "btn-close",
       "btn-cta",
@@ -340,7 +341,7 @@
     ],
     "ids": [
       "TableOfContents",
-      "_carbonads_js",
+      "ad-container",
       "add-buttons",
       "add-content",
       "add-mounts",
@@ -391,6 +392,7 @@
       "definition-list",
       "details",
       "diagrams-support",
+      "docs-single",
       "docsearch",
       "docsearch-lvl0",
       "documentation-pages",
@@ -422,6 +424,7 @@
       "heading-id",
       "headings",
       "highlight",
+      "homepage",
       "horizontal-rule",
       "hosting",
       "how-to-structure-page-content-in-doks",
@@ -448,6 +451,7 @@
       "nav-tab",
       "nav-tabContent",
       "next-steps",
+      "not-defined",
       "note-callout",
       "offcanvasNavMain",
       "offcanvasNavMainLabel",

layouts/_default/single.html

@@ -15,6 +15,9 @@
 			{{ if site.Params.add_ons.carbonAds -}}
       	{{ partial "main/carbon-ads" . }}
 			{{ end -}}
+			{{ if site.Params.add_ons.ethicalAds -}}
+				{{ partial "main/ethical-ads" . }}
+			{{ end -}}
 		</nav>
 		{{ end -}}
 		{{ if .Params.toc -}}

layouts/index.html

@@ -7,11 +7,12 @@ <h1>{{ .Title }}</h1>
     <div class="col-lg-9 col-xl-8 text-center">
       <p class="lead">{{ .Params.lead | safeHTML }}</p>
       <a class="btn btn-primary btn-cta rounded-pill btn-lg my-3" href="/docs/{{ if site.Params.doks.docsVersioning }}{{ site.Params.doks.docsVersion }}/{{ end }}start-here/getting-started/" role="button">{{ i18n "get_started" }}</a>
-
 			{{ if site.Params.add_ons.carbonAds -}}
       	{{ partial "main/carbon-ads" . }}
 			{{ end -}}
-
+			{{ if site.Params.add_ons.ethicalAds -}}
+        {{ partial "main/ethical-ads" . }}
+			{{ end -}}
     </div>
   </div>
 </section>

layouts/partials/main/ethical-ads.html

@@ -0,0 +1,12 @@
+<script async src="https://media.ethicalads.io/media/client/ethicalads.min.js"></script>
+
+{{- $ethicalAdsId := "" }}
+{{- if .IsHome }}
+  {{- $ethicalAdsId = "homepage" }}
+{{- else if and (eq .Section "docs") .IsPage }}
+  {{- $ethicalAdsId = "docs-single" }}
+{{- else }}
+  {{- $ethicalAdsId = "not-defined" }}
+{{- end }}
+
+<div data-ea-publisher="httpgetdoksorg" data-ea-type="image" class="bordered" id="{{ $ethicalAdsId }}"></div>

layouts/partials/sidebar/feedback.html

@@ -1,5 +1,5 @@
 <div class="feedback-links">
-  <h3>Give Feedback</h3>
+  <h3>Feedback</h3>
   <ul class="list-unstyled">
     <li><a href="https://github.com/gethyas/doks/issues/new/choose">Create an issue</a></li>
     <li><a href="https://github.com/gethyas/doks/discussions/new?category=ideas">Share an idea</a></li>

netlify.toml

@@ -38,7 +38,7 @@
     Strict-Transport-Security = "max-age=31536000; includeSubDomains; preload"
     X-Content-Type-Options = "nosniff"
     X-XSS-Protection = "1; mode=block"
-    Content-Security-Policy = "default-src 'self'; manifest-src 'self'; connect-src 'self' https://plausible.io https://srv.carbonads.net https://*.algolia.net https://*.algolianet.com https://*.algolia.io; font-src 'self'; img-src 'self' https://srv.carbonads.net https://avatars.githubusercontent.com data:; script-src 'self' https://plausible.io https://cdn.carbonads.com https://cdn.jsdelivr.net/ 'nonce-dXNlcj0iaGVsbG8iLGRvbWFpbj0iaGVua3ZlcmxpbmRlLmNvbSIsZG9jdW1lbnQud3JpdGUodXNlcisiQCIrZG9tYWluKTs=' 'sha256-aWZ3y/RxbBYKHXH0z8+8ljrHG1mSBvyzSfxSMjBSaXk='; style-src 'self' 'unsafe-inline'"
+    # Content-Security-Policy = "default-src 'self'; manifest-src 'self'; connect-src 'self' https://plausible.io https://srv.carbonads.net https://*.algolia.net https://*.algolianet.com https://*.algolia.io; font-src 'self'; img-src 'self' https://srv.carbonads.net https://avatars.githubusercontent.com data:; script-src 'self' https://plausible.io https://cdn.carbonads.com https://cdn.jsdelivr.net/ 'nonce-dXNlcj0iaGVsbG8iLGRvbWFpbj0iaGVua3ZlcmxpbmRlLmNvbSIsZG9jdW1lbnQud3JpdGUodXNlcisiQCIrZG9tYWluKTs=' 'sha256-aWZ3y/RxbBYKHXH0z8+8ljrHG1mSBvyzSfxSMjBSaXk='; style-src 'self' 'unsafe-inline'"
     X-Frame-Options = "SAMEORIGIN"
     Referrer-Policy = "strict-origin"
     Permissions-Policy = "geolocation=(self), microphone=(), camera=()"

resources/_gen/assets/scss/app.scss_901a6e181e810c5c7347a10d84f037ab.content

@@ -11825,6 +11825,55 @@ pre code::-webkit-scrollbar-thumb:hover {
     background: #17181c;
     border-color: #23262f; }
 
+[data-ea-type="image"].loaded {
+  margin: 1rem 0 2.25rem; }
+
+[data-ea-type="text"].loaded {
+  margin: 3rem 0; }
+
+/*
+[data-ea-publisher].loaded, [data-ea-type].loaded {
+  font-family: inherit !important;
+}
+*/
+.home [data-ea-publisher].loaded {
+  display: none;
+  z-index: 100;
+  position: fixed;
+  right: 1.25rem;
+  bottom: 1.25rem;
+  margin: 0; }
+  @media (min-width: 992px) {
+    .home [data-ea-publisher].loaded {
+      display: flex; } }
+[data-ea-publisher].loaded .ea-content, [data-ea-type].loaded .ea-content {
+  background-color: var(--bs-body-bg) !important;
+  border: 1px solid #e9ecef !important;
+  color: #1d2d35 !important; }
+
+[data-ea-publisher].loaded .ea-content a:link, [data-ea-type].loaded .ea-content a:link {
+  color: #1d2d35 !important; }
+
+[data-ea-publisher].loaded .ea-content a strong, [data-ea-publisher].loaded .ea-content a b, [data-ea-type].loaded .ea-content a strong, [data-ea-type].loaded .ea-content a b {
+  color: #5d2f86 !important; }
+
+[data-ea-publisher].loaded .ea-callout a:link, [data-ea-type].loaded .ea-callout a:link {
+  color: var(--bs-secondary-color) !important; }
+
+[data-bs-theme="dark"] [data-ea-publisher].loaded .ea-content, [data-bs-theme="dark"] [data-ea-type].loaded .ea-content {
+  background-color: #17181c !important;
+  border: 1px solid var(--sl-color-gray-5) !important;
+  color: #c1c3c8 !important; }
+
+[data-bs-theme="dark"] [data-ea-publisher].loaded .ea-content a:link, [data-bs-theme="dark"] [data-ea-type].loaded .ea-content a:link {
+  color: #c1c3c8 !important; }
+
+[data-bs-theme="dark"] [data-ea-publisher].loaded .ea-content a strong, [data-bs-theme="dark"] [data-ea-publisher].loaded .ea-content a b, [data-bs-theme="dark"] [data-ea-type].loaded .ea-content a strong, [data-bs-theme="dark"] [data-ea-type].loaded .ea-content a b {
+  color: #b3c7ff !important; }
+
+[data-bs-theme="dark"] [data-ea-publisher].loaded .ea-callout a:link, [data-bs-theme="dark"] [data-ea-type].loaded .ea-callout a:link {
+  color: #adafb6 !important; }
+
 #carbonads {
   display: block;
   overflow: hidden;

resources/_gen/assets/scss/app.scss_901a6e181e810c5c7347a10d84f037ab.json

@@ -1 +1 @@
-{"Target":"main.23a3109545ab261d29e3d67b18ecaee8ebd3796c1d7603655c9a3e64ebe0f5eeb1ff6f099177685b2fd9de548a29259573017985d934c218f0aa2e61ef23924f.css","MediaType":"text/css","Data":{"Integrity":"sha512-I6MQlUWrJh0p49Z7GOyu6OvTeWwddgNlXJo+ZOvg9e6x/28JkXdoWy/Z3lSKKSWVcwF5hdk0whjwqi5h7yOSTw=="}}
+{"Target":"main.098f655a4d33589e2d3866f0035a21509bb4b87fa054df9006aa21ec56d4e96a34b8d1cb39ae99c256c6a3fd03f227dcf018a90a13df5463b76c1e63d74803d4.css","MediaType":"text/css","Data":{"Integrity":"sha512-CY9lWk0zWJ4tOGbwA1ohUJu0uH+gVN+QBqoh7FbU6Wo0uNHLOa6ZwlbGo/0D8ifc8BipChPfVGO3bB5j10gD1A=="}}

resources/_gen/assets/scss/app.scss_cdf9d7c9eb97e4550ded64a8776dd9e8.json

@@ -0,0 +1 @@
+{"Target":"main.cd670232b606abfa2371b90410bcea5c4715c6898541eaf65967fe09a86dabbefb9a452c6bc6d032d80c51afb21c3c886abf75d8c1a8918d15cb72c995732134.css","MediaType":"text/css","Data":{"Integrity":"sha512-zWcCMrYGq/ojcbkEELzqXEcVxomFQer2WWf+Cahtq777mkUsa8bQMtgMUa+yHDyIar912MGokY0Vy3LJlXMhNA=="}}