docs: customize web site

VirusTotal · Mar 25, 2024 · 6ac8df1 · 6ac8df1
1 parent 5554b89
commit 6ac8df1
Show file tree

Hide file tree

Showing 11 changed files with 250 additions and 257 deletions.
diff --git a/site/assets/scss/common/_variables-custom.scss b/site/assets/scss/common/_variables-custom.scss
@@ -1 +1,11 @@
-// Put your custom SCSS variables here
+// Light mode
+$primary: rgb(231, 81, 21);
+
+// Dark mode
+$link-color-dark: rgb(231, 81, 21);
+$button-color-dark: rgb(248, 186, 17);
+
+:root,
+::backdrop {
+  --sl-color-accent-high: rgb(231, 81, 21);
+}
diff --git a/site/config/_default/hugo.toml b/site/config/_default/hugo.toml
@@ -1,4 +1,4 @@
-title = "My Docs"
+title = "YARA-X"
 baseurl = "/"
 canonifyURLs = false
 disableAliases = true
@@ -20,67 +20,67 @@ defaultContentLanguageInSubdir = false
 copyRight = "Copyright (c) 2020-2024 Hyas"
 
 [build.buildStats]
-  enable = true
+enable = true
 
 [outputs]
-  home = ["HTML", "RSS", "searchIndex"]
-  section = ["HTML", "RSS", "SITEMAP"]
+home = ["HTML", "RSS", "searchIndex"]
+section = ["HTML", "RSS", "SITEMAP"]
 
 [outputFormats.searchIndex]
-  mediaType = "application/json"
-  baseName = "search-index"
-  isPlainText = true
-  notAlternative = true
+mediaType = "application/json"
+baseName = "search-index"
+isPlainText = true
+notAlternative = true
 
 # Add output format for section sitemap.xml
 [outputFormats.SITEMAP]
-  mediaType = "application/xml"
-  baseName = "sitemap"
-  isHTML = false
-  isPlainText = true
-  noUgly = true
-  rel  = "sitemap"
+mediaType = "application/xml"
+baseName = "sitemap"
+isHTML = false
+isPlainText = true
+noUgly = true
+rel = "sitemap"
 
 [sitemap]
-  changefreq = "monthly"
-  filename = "sitemap.xml"
-  priority = 0.5
+changefreq = "monthly"
+filename = "sitemap.xml"
+priority = 0.5
 
 [caches]
-  [caches.getjson]
-    dir = ":cacheDir/:project"
-    maxAge = -1 # "30m"
+[caches.getjson]
+dir = ":cacheDir/:project"
+maxAge = -1 # "30m"
 
 [taxonomies]
-  contributor = "contributors"
-  category = "categories"
-  tag = "tags"
+contributor = "contributors"
+category = "categories"
+tag = "tags"
 
 [permalinks]
-  blog = "/blog/:slug/"
-  docs = "/docs/:sections[1:]/:slug/"
+blog = "/blog/:slug/"
+docs = "/docs/:sections[1:]/:slug/"
 # docs = "/docs/1.0/:sections[1:]/:slug/"
 
 [minify.tdewolff.html]
-  keepWhitespace = false
+keepWhitespace = false
 
 [related]
-  threshold = 80
-  includeNewer = true
-  toLower = false
-    [[related.indices]]
-      name = "categories"
-      weight = 100
-    [[related.indices]]
-      name = "tags"
-      weight = 80
-    [[related.indices]]
-      name = "date"
-      weight = 10
+threshold = 80
+includeNewer = true
+toLower = false
+[[related.indices]]
+name = "categories"
+weight = 100
+[[related.indices]]
+name = "tags"
+weight = 80
+[[related.indices]]
+name = "date"
+weight = 10
 
 [imaging]
-  anchor = "Center"
-  bgColor = "#ffffff"
-  hint = "photo"
-  quality = 85
-  resampleFilter = "Lanczos"
+anchor = "Center"
+bgColor = "#ffffff"
+hint = "photo"
+quality = 85
+resampleFilter = "Lanczos"
diff --git a/site/config/_default/languages.toml b/site/config/_default/languages.toml
@@ -1,32 +1,9 @@
 [en]
-  languageName = "English"
-  contentDir = "content/en"
-  weight = 10
-  [en.params]
-    languageISO = "EN"
-    languageTag = "en-US"
-    footer = 'Brought to you by <a class="text-muted" href="https://gethyas.com/">Hyas</a>'
-    alertText = '<a class="alert-link stretched-link fw-normal" href="/blog/example-post/">Doks version 1.0 just shipped!</a>'
+languageName = "English"
+contentDir = "content/en"
+weight = 10
 
-[de]
-  languageName = "German"
-  contentDir = "content/de"
-  weight = 15
-  [de.params]
-    languageISO = "DE"
-    languageTag = "de-DE"
-    footer = 'Gebaut mit <a class="text-muted" href="https://gethyas.com/">Hyas</a>'
-    alertText = 'Neue Version ist da! <a class="alert-link stretched-link" href="https://getdoks.org/blog/doks-v0.5/">Doks v0.5</a>'
-
-[nl]
-  languageName = "Nederlands"
-  contentDir = "content/nl"
-  weight = 20
-  [nl.params]
-    languageISO = "NL"
-    languageTag = "nl-NL"
-    titleAddition = "Modern documentatie-thema"
-    description = "Doks is een Hugo-thema waarmee je moderne documentatie-websites kunt bouwen die veilig, snel en klaar voor SEO zijn — standaard."
-    titleHome = "Doks thema"
-    footer = 'Mogelijk gemaakt door <a href="https://www.netlify.com/">Netlify</a>, <a href="https://gohugo.io/">Hugo</a>, en <a href="https://getdoks.org/">Doks</a>'
-    alertText = 'Introductie van het Doks-kinderthema, verschillende DX + UX-updates en meer! <a class="alert-link stretched-link" href="https://getdoks.org/blog/doks-v0.2/">Bekijk Doks v0.2</a>'
+[en.params]
+languageISO = "EN"
+languageTag = "en-US"
+footer = 'Brought to you by <a class="text-muted" href="https://www.virustotal.com/">VirusTotal</a>'
diff --git a/site/config/_default/menus/menus.en.toml b/site/config/_default/menus/menus.en.toml
@@ -17,27 +17,27 @@
 #   url = "/docs/lorem/"
 
 [[guide]]
-  name = "Lorem"
-  weight = 10
-  identifier = "lorem"
-  url = "/guide/lorem/"
+name = "Lorem"
+weight = 10
+identifier = "lorem"
+url = "/guide/lorem/"
 
 [[tutorial]]
-  name = "Lorem"
-  weight = 10
-  identifier = "lorem"
-  url = "/tutorial/lorem/"
+name = "Lorem"
+weight = 10
+identifier = "lorem"
+url = "/tutorial/lorem/"
 
 [[main]]
-  name = "Docs"
-  url = "/docs/guides/example-guide/"
+name = "Docs"
+url = "/docs/guides/example-guide/"
 # url = "/docs/1.0/prologue/introduction/"
-  weight = 10
+weight = 10
 
 [[main]]
-  name = "Blog"
-  url = "/blog/"
-  weight = 30
+name = "Blog"
+url = "/blog/"
+weight = 30
 
 # [[social]]
 #   name = "Twitter"
@@ -52,18 +52,13 @@
 #   weight = 20
 
 [[social]]
-  name = "GitHub"
-  pre = '<svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-brand-github" width="24" height="24" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M9 19c-4.3 1.4 -4.3 -2.5 -6 -3m12 5v-3.5c0 -1 .1 -1.4 -.5 -2c2.8 -.3 5.5 -1.4 5.5 -6a4.6 4.6 0 0 0 -1.3 -3.2a4.2 4.2 0 0 0 -.1 -3.2s-1.1 -.3 -3.5 1.3a12.3 12.3 0 0 0 -6.2 0c-2.4 -1.6 -3.5 -1.3 -3.5 -1.3a4.2 4.2 0 0 0 -.1 3.2a4.6 4.6 0 0 0 -1.3 3.2c0 4.6 2.7 5.7 5.5 6c-.6 .6 -.6 1.2 -.5 2v3.5"></path></svg>'
-  url = "https://github.com/gethyas/doks"
-  post = "v0.1.0"
-  weight = 30
-
-[[footer]]
-  name = "Privacy Policy"
-  url = "/privacy/"
-  weight = 10
+name = "GitHub"
+pre = '<svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-brand-github" width="24" height="24" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M9 19c-4.3 1.4 -4.3 -2.5 -6 -3m12 5v-3.5c0 -1 .1 -1.4 -.5 -2c2.8 -.3 5.5 -1.4 5.5 -6a4.6 4.6 0 0 0 -1.3 -3.2a4.2 4.2 0 0 0 -.1 -3.2s-1.1 -.3 -3.5 1.3a12.3 12.3 0 0 0 -6.2 0c-2.4 -1.6 -3.5 -1.3 -3.5 -1.3a4.2 4.2 0 0 0 -.1 3.2a4.6 4.6 0 0 0 -1.3 3.2c0 4.6 2.7 5.7 5.5 6c-.6 .6 -.6 1.2 -.5 2v3.5"></path></svg>'
+url = "https://github.com/VirusTotal/yara-x"
+post = "v0.1.0"
+weight = 30
 
 # [[footer]]
-#   name = "Terms of Service"
-#   url = "/terms/"
-#   weight = 20
+# name = "By VirusTotal"
+# url = "https://www.virustotal.com"
+# weight = 10