diff --git a/website/.editorconfig b/website/.editorconfig index c6197a1..dad6b58 100644 --- a/website/.editorconfig +++ b/website/.editorconfig @@ -1,11 +1,11 @@ -# editorconfig.org - -root = true - -[*] -indent_style = space -indent_size = 2 -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true +# editorconfig.org + +root = true + +[*] +indent_style = space +indent_size = 2 +end_of_line = lf +charset = utf-8 +trim_trailing_whitespace = true insert_final_newline = true \ No newline at end of file diff --git a/website/.eslintrc.json b/website/.eslintrc.json index d9d2fc7..c926994 100644 --- a/website/.eslintrc.json +++ b/website/.eslintrc.json @@ -1,31 +1,31 @@ -{ - "env": { - "browser": true, - "commonjs": true, - "es6": true, - "node": true - }, - "extends": "eslint:recommended", - "globals": { - "Atomics": "readonly", - "SharedArrayBuffer": "readonly" - }, - "parserOptions": { - "ecmaVersion": 2018, - "sourceType": "module" - }, - "rules": { - "no-console": 0, - "quotes": ["error", "single"], - "comma-dangle": [ - "error", - { - "arrays": "always-multiline", - "objects": "always-multiline", - "imports": "always-multiline", - "exports": "always-multiline", - "functions": "ignore" - } - ] - } +{ + "env": { + "browser": true, + "commonjs": true, + "es6": true, + "node": true + }, + "extends": "eslint:recommended", + "globals": { + "Atomics": "readonly", + "SharedArrayBuffer": "readonly" + }, + "parserOptions": { + "ecmaVersion": 2018, + "sourceType": "module" + }, + "rules": { + "no-console": 0, + "quotes": ["error", "single"], + "comma-dangle": [ + "error", + { + "arrays": "always-multiline", + "objects": "always-multiline", + "imports": "always-multiline", + "exports": "always-multiline", + "functions": "ignore" + } + ] + } } \ No newline at end of file diff --git a/website/.gitpod.yml b/website/.gitpod.yml index 1e7958f..ff80519 100644 --- a/website/.gitpod.yml +++ b/website/.gitpod.yml @@ -1,12 +1,12 @@ -# Source: -# - https://github.com/gitpod-io/template-hugo -# - https://www.gitpod.io/docs/configure/workspaces/tasks#one-line-tasks - -tasks: - - name: Run development server - init: pnpm install - command: pnpm dev - -ports: - - port: 1313 - onOpen: open-preview +# Source: +# - https://github.com/gitpod-io/template-hugo +# - https://www.gitpod.io/docs/configure/workspaces/tasks#one-line-tasks + +tasks: + - name: Run development server + init: pnpm install + command: pnpm dev + +ports: + - port: 1313 + onOpen: open-preview diff --git a/website/.markdownlint-cli2.jsonc b/website/.markdownlint-cli2.jsonc index ab08d78..f3d4ce1 100644 --- a/website/.markdownlint-cli2.jsonc +++ b/website/.markdownlint-cli2.jsonc @@ -1,14 +1,14 @@ -{ - "config": { - "default": true, - "MD013": false, - "MD022": false, - "MD024": false, - "MD025": false, - "MD026": false, - "MD033": false, - "MD034": false, - "MD036": false - }, - "ignores": ["node_modules", "CHANGELOG.md", "README.md"] +{ + "config": { + "default": true, + "MD013": false, + "MD022": false, + "MD024": false, + "MD025": false, + "MD026": false, + "MD033": false, + "MD034": false, + "MD036": false + }, + "ignores": ["node_modules", "CHANGELOG.md", "README.md"] } \ No newline at end of file diff --git a/website/.npmignore b/website/.npmignore index 7be0f0e..81e0bb4 100644 --- a/website/.npmignore +++ b/website/.npmignore @@ -1,8 +1,8 @@ -.eslintcache -.stylelintcache -.netlify -.hugo_build.lock -yarn-error.log -node_modules -public -resources +.eslintcache +.stylelintcache +.netlify +.hugo_build.lock +yarn-error.log +node_modules +public +resources diff --git a/website/.npmrc b/website/.npmrc index 86dc215..2f4f5b8 100644 --- a/website/.npmrc +++ b/website/.npmrc @@ -1,4 +1,4 @@ -enable-pre-post-scripts = true -auto-install-peers = true -node-linker = hoisted +enable-pre-post-scripts = true +auto-install-peers = true +node-linker = hoisted prefer-symlinked-executables = false \ No newline at end of file diff --git a/website/.stylelintignore b/website/.stylelintignore index d02e199..5100c9b 100644 --- a/website/.stylelintignore +++ b/website/.stylelintignore @@ -1,2 +1,2 @@ -assets/scss/common/_variables-custom.scss +assets/scss/common/_variables-custom.scss node_modules \ No newline at end of file diff --git a/website/.stylelintrc.json b/website/.stylelintrc.json index acf43c5..1034dfd 100644 --- a/website/.stylelintrc.json +++ b/website/.stylelintrc.json @@ -1,35 +1,35 @@ -{ - "extends": "stylelint-config-standard-scss", - "rules": { - "no-empty-source": null, - "scss/comment-no-empty": null, - "scss/at-extend-no-missing-placeholder": null, - "at-rule-no-unknown": [ - true, - { - "ignoreAtRules": [ - "extend", - "at-root", - "debug", - "warn", - "error", - "if", - "else", - "for", - "each", - "while", - "mixin", - "include", - "content", - "return", - "function", - "tailwind", - "apply", - "responsive", - "variants", - "screen" - ] - } - ] - } +{ + "extends": "stylelint-config-standard-scss", + "rules": { + "no-empty-source": null, + "scss/comment-no-empty": null, + "scss/at-extend-no-missing-placeholder": null, + "at-rule-no-unknown": [ + true, + { + "ignoreAtRules": [ + "extend", + "at-root", + "debug", + "warn", + "error", + "if", + "else", + "for", + "each", + "while", + "mixin", + "include", + "content", + "return", + "function", + "tailwind", + "apply", + "responsive", + "variants", + "screen" + ] + } + ] + } } \ No newline at end of file diff --git a/website/assets/js/custom.js b/website/assets/js/custom.js index c5525d0..b174611 100644 --- a/website/assets/js/custom.js +++ b/website/assets/js/custom.js @@ -1 +1 @@ -// Put your custom JS code here +// Put your custom JS code here diff --git a/website/assets/scss/common/_custom.scss b/website/assets/scss/common/_custom.scss index f7c1361..cc4e2b5 100644 --- a/website/assets/scss/common/_custom.scss +++ b/website/assets/scss/common/_custom.scss @@ -1 +1 @@ -// Put your custom SCSS code here +// Put your custom SCSS code here diff --git a/website/assets/scss/common/_variables-custom.scss b/website/assets/scss/common/_variables-custom.scss index d2280cc..56c9eb7 100644 --- a/website/assets/scss/common/_variables-custom.scss +++ b/website/assets/scss/common/_variables-custom.scss @@ -1 +1 @@ -// Put your custom SCSS variables here +// Put your custom SCSS variables here diff --git a/website/config/_default/hugo.toml b/website/config/_default/hugo.toml index 4979601..963302d 100644 --- a/website/config/_default/hugo.toml +++ b/website/config/_default/hugo.toml @@ -1,89 +1,89 @@ -title = "Perses" -baseurl = "/" -canonifyURLs = false -disableAliases = true -disableHugoGeneratorInject = true -# disableKinds = ["taxonomy", "term"] -enableEmoji = true -enableGitInfo = false -enableRobotsTXT = true -languageCode = "en-US" -paginate = 10 -rssLimit = 10 -summarylength = 20 # 70 (default) - -# Multilingual -defaultContentLanguage = "en" -disableLanguages = ["de", "nl"] -defaultContentLanguageInSubdir = false - -copyRight = "Copyright (c) 2023 Perses" - -[build.buildStats] -enable = true - -[social] -twitter = "" - -[outputs] -home = ["HTML", "RSS", "searchIndex"] -section = ["HTML", "RSS", "SITEMAP"] - -[outputFormats.searchIndex] -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" - -[sitemap] -changefreq = "monthly" -filename = "sitemap.xml" -priority = 0.5 - -[caches] -[caches.getjson] -dir = ":cacheDir/:project" -maxAge = "30m" - -[taxonomies] -contributor = "contributors" -category = "categories" -tag = "tags" - -[permalinks] -blog = "/blog/:slug/" -docs = "/docs/:sections[1:]/:slug/" -# docs = "/docs/1.0/:sections[1:]/:slug/" - -[minify.tdewolff.html] -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 - -[imaging] -anchor = "Smart" -bgColor = "#ffffff" -hint = "photo" -quality = 75 -resampleFilter = "Box" +title = "Perses" +baseurl = "/" +canonifyURLs = false +disableAliases = true +disableHugoGeneratorInject = true +# disableKinds = ["taxonomy", "term"] +enableEmoji = true +enableGitInfo = false +enableRobotsTXT = true +languageCode = "en-US" +paginate = 10 +rssLimit = 10 +summarylength = 20 # 70 (default) + +# Multilingual +defaultContentLanguage = "en" +disableLanguages = ["de", "nl"] +defaultContentLanguageInSubdir = false + +copyRight = "Copyright (c) 2023 Perses" + +[build.buildStats] +enable = true + +[social] +twitter = "" + +[outputs] +home = ["HTML", "RSS", "searchIndex"] +section = ["HTML", "RSS", "SITEMAP"] + +[outputFormats.searchIndex] +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" + +[sitemap] +changefreq = "monthly" +filename = "sitemap.xml" +priority = 0.5 + +[caches] +[caches.getjson] +dir = ":cacheDir/:project" +maxAge = "30m" + +[taxonomies] +contributor = "contributors" +category = "categories" +tag = "tags" + +[permalinks] +blog = "/blog/:slug/" +docs = "/docs/:sections[1:]/:slug/" +# docs = "/docs/1.0/:sections[1:]/:slug/" + +[minify.tdewolff.html] +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 + +[imaging] +anchor = "Smart" +bgColor = "#ffffff" +hint = "photo" +quality = 75 +resampleFilter = "Box" diff --git a/website/config/_default/languages.toml b/website/config/_default/languages.toml index e360c44..42f42da 100644 --- a/website/config/_default/languages.toml +++ b/website/config/_default/languages.toml @@ -1,10 +1,10 @@ -[en] -languageName = "English" -contentDir = "content/en" -weight = 10 - -[en.params] -languageISO = "EN" -languageTag = "en-US" -footer = 'Brought to you by Hyas' -alertText = 'Doks version 1.0 just shipped!' +[en] +languageName = "English" +contentDir = "content/en" +weight = 10 + +[en.params] +languageISO = "EN" +languageTag = "en-US" +footer = 'Brought to you by Hyas' +alertText = 'Doks version 1.0 just shipped!' diff --git a/website/config/_default/markup.toml b/website/config/_default/markup.toml index fd61a8e..a9d0f26 100644 --- a/website/config/_default/markup.toml +++ b/website/config/_default/markup.toml @@ -1,33 +1,33 @@ -defaultMarkdownHandler = "goldmark" - -[goldmark] -[goldmark.extensions] -linkify = false -[goldmark.parser] -autoHeadingID = true -autoHeadingIDType = "github" -[goldmark.parser.attribute] -block = true -title = true -[goldmark.renderer] -unsafe = true - -[highlight] -anchorLineNos = false -codeFences = true -guessSyntax = false -hl_Lines = '' -hl_inline = false -lineAnchors = '' -lineNoStart = 1 -lineNos = false -lineNumbersInTable = false -noClasses = false -noHl = false -style = 'github-dark' -tabWidth = 4 - -[tableOfContents] -endLevel = 3 -ordered = false -startLevel = 2 +defaultMarkdownHandler = "goldmark" + +[goldmark] +[goldmark.extensions] +linkify = false +[goldmark.parser] +autoHeadingID = true +autoHeadingIDType = "github" +[goldmark.parser.attribute] +block = true +title = true +[goldmark.renderer] +unsafe = true + +[highlight] +anchorLineNos = false +codeFences = true +guessSyntax = false +hl_Lines = '' +hl_inline = false +lineAnchors = '' +lineNoStart = 1 +lineNos = false +lineNumbersInTable = false +noClasses = false +noHl = false +style = 'github-dark' +tabWidth = 4 + +[tableOfContents] +endLevel = 3 +ordered = false +startLevel = 2 diff --git a/website/config/_default/menus/menus.en.toml b/website/config/_default/menus/menus.en.toml index 35d02ea..c8f5c8f 100644 --- a/website/config/_default/menus/menus.en.toml +++ b/website/config/_default/menus/menus.en.toml @@ -1,35 +1,35 @@ -[[main]] -name = "Docs" -url = "/docs/prologue/introduction.md/" -# url = "/docs/1.0/prologue/introduction/" -weight = 10 - - -# [[social]] -# name = "Twitter" -# pre = '' -# url = "https://twitter.com/getdoks" -# weight = 10 -# -# [[social]] -# name = "Discord" -# pre = '' -# url = "https://getdoks.org/chat" -# weight = 20 - -[[social]] -name = "GitHub" -pre = '' -url = "https://github.com/perses/perses" -post = "v0.1.0" -weight = 30 - -[[footer]] -name = "Privacy Policy" -url = "/privacy/" -weight = 10 - -# [[footer]] -# name = "Terms of Service" -# url = "/terms/" -# weight = 20 +[[main]] +name = "Docs" +url = "/docs/prologue/introduction.md/" +# url = "/docs/1.0/prologue/introduction/" +weight = 10 + + +# [[social]] +# name = "Twitter" +# pre = '' +# url = "https://twitter.com/getdoks" +# weight = 10 +# +# [[social]] +# name = "Discord" +# pre = '' +# url = "https://getdoks.org/chat" +# weight = 20 + +[[social]] +name = "GitHub" +pre = '' +url = "https://github.com/perses/perses" +post = "v0.1.0" +weight = 30 + +[[footer]] +name = "Privacy Policy" +url = "/privacy/" +weight = 10 + +# [[footer]] +# name = "Terms of Service" +# url = "/terms/" +# weight = 20 diff --git a/website/config/_default/module.toml b/website/config/_default/module.toml index 29392f0..d60802c 100644 --- a/website/config/_default/module.toml +++ b/website/config/_default/module.toml @@ -1,108 +1,108 @@ -# mounts -## archetypes -[[mounts]] -source = "node_modules/@hyas/doks-core/archetypes" -target = "archetypes" - -[[mounts]] -source = "archetypes" -target = "archetypes" - -## assets -[[mounts]] -source = "node_modules/@hyas/core/assets" -target = "assets" - -[[mounts]] -source = "node_modules/@hyas/images/assets" -target = "assets" -excludeFiles = "/scss/**.scss" - -[[mounts]] -source = "node_modules/@hyas/doks-core/assets" -target = "assets" -excludeFiles = [ - "scss/common/_variables-custom.scss", - "scss/common/_custom.scss", -] - -[[mounts]] -source = "node_modules/flexsearch" -target = "assets/js/vendor/flexsearch" - -[[mounts]] -source = "node_modules/katex" -target = "assets/js/vendor/katex" - -[[mounts]] -source = "node_modules/mermaid" -target = "assets/js/vendor/mermaid" - -[[mounts]] -source = "node_modules/@tabler/icons/icons" -target = "assets/svgs/tabler-icons" - -[[mounts]] -source = "assets" -target = "assets" - -## content -[[mounts]] -source = "content" -target = "content" - -## data -[[mounts]] -source = "node_modules/@hyas/doks-core/data" -target = "data" - -[[mounts]] -source = "config/_default/hyas" -target = "data" - -[[mounts]] -source = "data" -target = "data" - -## i18n -[[mounts]] -source = "node_modules/@hyas/doks-core/i18n" -target = "i18n" - -[[mounts]] -source = "i18n" -target = "i18n" - -## layouts -[[mounts]] -source = "node_modules/@hyas/core/layouts" -target = "layouts" - -[[mounts]] -source = "node_modules/@hyas/seo/layouts" -target = "layouts" - -[[mounts]] -source = "node_modules/@hyas/images/layouts" -target = "layouts" - -[[mounts]] -source = "node_modules/@hyas/doks-core/layouts" -target = "layouts" - -[[mounts]] -source = "node_modules/@hyas/inline-svg/layouts" -target = "layouts" - -[[mounts]] -source = "layouts" -target = "layouts" - -## static -[[mounts]] -source = "node_modules/@hyas/doks-core/static" -target = "static" - -[[mounts]] -source = "static" -target = "static" +# mounts +## archetypes +[[mounts]] +source = "node_modules/@hyas/doks-core/archetypes" +target = "archetypes" + +[[mounts]] +source = "archetypes" +target = "archetypes" + +## assets +[[mounts]] +source = "node_modules/@hyas/core/assets" +target = "assets" + +[[mounts]] +source = "node_modules/@hyas/images/assets" +target = "assets" +excludeFiles = "/scss/**.scss" + +[[mounts]] +source = "node_modules/@hyas/doks-core/assets" +target = "assets" +excludeFiles = [ + "scss/common/_variables-custom.scss", + "scss/common/_custom.scss", +] + +[[mounts]] +source = "node_modules/flexsearch" +target = "assets/js/vendor/flexsearch" + +[[mounts]] +source = "node_modules/katex" +target = "assets/js/vendor/katex" + +[[mounts]] +source = "node_modules/mermaid" +target = "assets/js/vendor/mermaid" + +[[mounts]] +source = "node_modules/@tabler/icons/icons" +target = "assets/svgs/tabler-icons" + +[[mounts]] +source = "assets" +target = "assets" + +## content +[[mounts]] +source = "content" +target = "content" + +## data +[[mounts]] +source = "node_modules/@hyas/doks-core/data" +target = "data" + +[[mounts]] +source = "config/_default/hyas" +target = "data" + +[[mounts]] +source = "data" +target = "data" + +## i18n +[[mounts]] +source = "node_modules/@hyas/doks-core/i18n" +target = "i18n" + +[[mounts]] +source = "i18n" +target = "i18n" + +## layouts +[[mounts]] +source = "node_modules/@hyas/core/layouts" +target = "layouts" + +[[mounts]] +source = "node_modules/@hyas/seo/layouts" +target = "layouts" + +[[mounts]] +source = "node_modules/@hyas/images/layouts" +target = "layouts" + +[[mounts]] +source = "node_modules/@hyas/doks-core/layouts" +target = "layouts" + +[[mounts]] +source = "node_modules/@hyas/inline-svg/layouts" +target = "layouts" + +[[mounts]] +source = "layouts" +target = "layouts" + +## static +[[mounts]] +source = "node_modules/@hyas/doks-core/static" +target = "static" + +[[mounts]] +source = "static" +target = "static" diff --git a/website/config/_default/params.toml b/website/config/_default/params.toml index f68ec0d..b6936ab 100644 --- a/website/config/_default/params.toml +++ b/website/config/_default/params.toml @@ -1,142 +1,142 @@ -# Hugo -title = "Perses" -description = "The CNCF candidate for observability visualisation." -images = [] - -# Doks (@hyas/doks-core) -[doks] -# Color mode -colorMode = "auto" # auto (default), light or dark -colorModeToggler = true # true (default) or false (this setting is only relevant when colorMode = auto) - -# Navbar -navbarSticky = true # true (default) or false -containerBreakpoint = "lg" # "", "sm", "md", "lg" (default), "xl", "xxl", or "fluid" - -## Button -navBarButton = false # false (default) or true -navBarButtonUrl = "/docs/prologue/introduction.md" -navBarButtonText = "Get started" - -# FlexSearch -flexSearch = true # true (default) or false -searchExclKinds = [ -] # list of page kinds to exclude from search indexing (e.g. ["home", "taxonomy", "term"] ) -searchExclTypes = [ -] # list of content types to exclude from search indexing (e.g. ["blog", "docs", "legal", "contributors", "categories"]) -showSearch = [ -] # [] (all pages, default) or homepage (optionally) and list of sections (e.g. ["homepage", "blog", "guides"]) -indexSummary = false # true or false (default); whether to index only the `.Summary` instead of the full `.Content`; limits the respective JSON field size and thus increases loading time - -## Search results -showDate = false # false (default) or true -showSummary = true # true (default) or false -searchLimit = 99 # 0 (no limit, default) or natural number - -# Global alert -alert = false # false (default) or true -alertDismissable = true # true (default) or false - -# Bootstrap -bootstrapJavascript = false # false (default) or true - -# Nav -sectionNav = [ - "docs", -] # ["docs"] (default) or list of sections (e.g. ["docs", "guides"]) -toTopButton = false # false (default) or true -breadcrumbTrail = false # false (default) or true -headlineHash = true # true (default) or false -scrollSpy = true # true (default) or false - -# Multilingual -multilingualMode = false # false (default) or true -showMissingLanguages = true # whether or not to show untranslated languages in the language menu; true (default) or false - -# Versioning -docsVersioning = false # false (default) or true -docsVersion = "1.0" - -# UX -headerBar = false # true (default) or false -backgroundDots = true # true (default) or false - -# Homepage -sectionFooter = false # false (default) or true - -# Blog -relatedPosts = false # false (default) or true -imageList = true # true (default) or false -imageSingle = true # true (default) or false - -# KaTex -katex = false - -# Repository -editPage = false # false (default) or true -lastMod = true # false (default) or true -repoHost = "GitHub" # GitHub (default), Gitea, GitLab, Bitbucket, or BitbucketServer -docsRepo = "https://github.com/perses/perses" -docsRepoBranch = "main" # main (default), master, or -docsRepoSubPath = "" # "" (none, default) or - -# SCSS colors -# backGround = "yellowgreen" -## Dark theme -# textDark = "#dee2e6" # "#dee2e6" (default), "#dee2e6" (orignal), or custom color -# accentDark = "#5d2f86" # "#5d2f86" (default), "#5d2f86" (original), or custom color -## Light theme -# textLight = "#1d2d35" # "#1d2d35" (default), "#1d2d35" (orignal), or custom color -# accentLight = "#8ed6fb" # "#8ed6fb" (default), "#8ed6fb" (orignal), or custom color - -[doks.menu] -[doks.menu.section] -auto = true # true (default) or false -collapsibleSidebar = true # true (default) or false - -# Debug -[render_hooks.image] -errorLevel = 'ignore' # ignore (default), warning, or error (fails the build) - -[render_hooks.link] -errorLevel = 'ignore' # ignore (default), warning, or error (fails the build) -highlightBroken = false # true or false (default) - -# Images (@hyas/images) -[hyas_images] -[hyas_images.landscape] -normalize = "1360x765" # "1600x900" (default) -lqip = "16x9" # "16x9" (default) -widths = [480, 640, 800, 1024] -[hyas_images.portrait] -normalize = "765x1360" # "900x1600" (default) -lqip = "9x16" # "9x16" (default) -widths = [480, 640, 800, 1024] - -# Inline SVG (@hyas/inline-svg) -[inline_svg] -iconSetDir = "tabler-icons" # "tabler-icons" (default) - -# SEO (@hyas/seo) -[seo] -[seo.title] -separator = " | " -suffix = "" -[seo.favicons] -sizes = [] -icon = "favicon.png" # favicon.png (default) -svgIcon = "" # favicon.svg (default) -maskIcon = "mask-icon.svg" # mask-icon.svg (default) -maskIconColor = "white" # white (default) -[seo.schemas] -type = "Organization" # Organization (default) or Person -logo = "logo_cropped.png" # Logo of Organization — favicon-512x512.png (default) -name = "Perses" # Name of Organization or Person -sameAs = [ - "https://github.com/perses/perses", -] # E.g. ["https://github.com/gethyas/hyas", "https://fosstodon.org/@hyas"] -images = ["cover.png", "logo_cropped.png"] # ["cover.png"] (default) -article = [] # Article sections -newsArticle = [] # NewsArticle sections -blogPosting = ["blog"] # BlogPosting sections -product = [] # Product sections +# Hugo +title = "Perses" +description = "The CNCF candidate for observability visualisation." +images = [] + +# Doks (@hyas/doks-core) +[doks] +# Color mode +colorMode = "auto" # auto (default), light or dark +colorModeToggler = true # true (default) or false (this setting is only relevant when colorMode = auto) + +# Navbar +navbarSticky = true # true (default) or false +containerBreakpoint = "lg" # "", "sm", "md", "lg" (default), "xl", "xxl", or "fluid" + +## Button +navBarButton = false # false (default) or true +navBarButtonUrl = "/docs/prologue/introduction.md" +navBarButtonText = "Get started" + +# FlexSearch +flexSearch = true # true (default) or false +searchExclKinds = [ +] # list of page kinds to exclude from search indexing (e.g. ["home", "taxonomy", "term"] ) +searchExclTypes = [ +] # list of content types to exclude from search indexing (e.g. ["blog", "docs", "legal", "contributors", "categories"]) +showSearch = [ +] # [] (all pages, default) or homepage (optionally) and list of sections (e.g. ["homepage", "blog", "guides"]) +indexSummary = false # true or false (default); whether to index only the `.Summary` instead of the full `.Content`; limits the respective JSON field size and thus increases loading time + +## Search results +showDate = false # false (default) or true +showSummary = true # true (default) or false +searchLimit = 99 # 0 (no limit, default) or natural number + +# Global alert +alert = false # false (default) or true +alertDismissable = true # true (default) or false + +# Bootstrap +bootstrapJavascript = false # false (default) or true + +# Nav +sectionNav = [ + "docs", +] # ["docs"] (default) or list of sections (e.g. ["docs", "guides"]) +toTopButton = false # false (default) or true +breadcrumbTrail = false # false (default) or true +headlineHash = true # true (default) or false +scrollSpy = true # true (default) or false + +# Multilingual +multilingualMode = false # false (default) or true +showMissingLanguages = true # whether or not to show untranslated languages in the language menu; true (default) or false + +# Versioning +docsVersioning = false # false (default) or true +docsVersion = "1.0" + +# UX +headerBar = false # true (default) or false +backgroundDots = true # true (default) or false + +# Homepage +sectionFooter = false # false (default) or true + +# Blog +relatedPosts = false # false (default) or true +imageList = true # true (default) or false +imageSingle = true # true (default) or false + +# KaTex +katex = false + +# Repository +editPage = false # false (default) or true +lastMod = true # false (default) or true +repoHost = "GitHub" # GitHub (default), Gitea, GitLab, Bitbucket, or BitbucketServer +docsRepo = "https://github.com/perses/perses" +docsRepoBranch = "main" # main (default), master, or +docsRepoSubPath = "" # "" (none, default) or + +# SCSS colors +# backGround = "yellowgreen" +## Dark theme +# textDark = "#dee2e6" # "#dee2e6" (default), "#dee2e6" (orignal), or custom color +# accentDark = "#5d2f86" # "#5d2f86" (default), "#5d2f86" (original), or custom color +## Light theme +# textLight = "#1d2d35" # "#1d2d35" (default), "#1d2d35" (orignal), or custom color +# accentLight = "#8ed6fb" # "#8ed6fb" (default), "#8ed6fb" (orignal), or custom color + +[doks.menu] +[doks.menu.section] +auto = true # true (default) or false +collapsibleSidebar = true # true (default) or false + +# Debug +[render_hooks.image] +errorLevel = 'ignore' # ignore (default), warning, or error (fails the build) + +[render_hooks.link] +errorLevel = 'ignore' # ignore (default), warning, or error (fails the build) +highlightBroken = false # true or false (default) + +# Images (@hyas/images) +[hyas_images] +[hyas_images.landscape] +normalize = "1360x765" # "1600x900" (default) +lqip = "16x9" # "16x9" (default) +widths = [480, 640, 800, 1024] +[hyas_images.portrait] +normalize = "765x1360" # "900x1600" (default) +lqip = "9x16" # "9x16" (default) +widths = [480, 640, 800, 1024] + +# Inline SVG (@hyas/inline-svg) +[inline_svg] +iconSetDir = "tabler-icons" # "tabler-icons" (default) + +# SEO (@hyas/seo) +[seo] +[seo.title] +separator = " | " +suffix = "" +[seo.favicons] +sizes = [] +icon = "favicon.png" # favicon.png (default) +svgIcon = "" # favicon.svg (default) +maskIcon = "mask-icon.svg" # mask-icon.svg (default) +maskIconColor = "white" # white (default) +[seo.schemas] +type = "Organization" # Organization (default) or Person +logo = "logo_cropped.png" # Logo of Organization — favicon-512x512.png (default) +name = "Perses" # Name of Organization or Person +sameAs = [ + "https://github.com/perses/perses", +] # E.g. ["https://github.com/gethyas/hyas", "https://fosstodon.org/@hyas"] +images = ["cover.png", "logo_cropped.png"] # ["cover.png"] (default) +article = [] # Article sections +newsArticle = [] # NewsArticle sections +blogPosting = ["blog"] # BlogPosting sections +product = [] # Product sections diff --git a/website/config/babel.config.js b/website/config/babel.config.js index ddd2b2e..e34c0a7 100644 --- a/website/config/babel.config.js +++ b/website/config/babel.config.js @@ -1,17 +1,17 @@ -module.exports = { - presets: [ - [ - '@babel/preset-env', - { - targets: { - browsers: [ - // Best practice: https://github.com/babel/babel/issues/7789 - '>=1%', - 'not ie 11', - 'not op_mini all', - ], - }, - }, - ], - ], -}; +module.exports = { + presets: [ + [ + '@babel/preset-env', + { + targets: { + browsers: [ + // Best practice: https://github.com/babel/babel/issues/7789 + '>=1%', + 'not ie 11', + 'not op_mini all', + ], + }, + }, + ], + ], +}; diff --git a/website/config/next/hugo.toml b/website/config/next/hugo.toml index bb8250e..9fad6c9 100644 --- a/website/config/next/hugo.toml +++ b/website/config/next/hugo.toml @@ -1 +1 @@ -# Overrides for next environment +# Overrides for next environment diff --git a/website/config/postcss.config.js b/website/config/postcss.config.js index 5a0bc44..f8da99b 100644 --- a/website/config/postcss.config.js +++ b/website/config/postcss.config.js @@ -1,68 +1,68 @@ -const autoprefixer = require('autoprefixer'); -const purgecss = require('@fullhuman/postcss-purgecss'); -const whitelister = require('purgecss-whitelister'); - -module.exports = { - plugins: [ - autoprefixer(), - purgecss({ - content: [ './hugo_stats.json' ], - extractors: [ - { - extractor: (content) => { - const els = JSON.parse(content).htmlElements; - return els.tags.concat(els.classes, els.ids); - }, - extensions: ['json'], - }, - ], - dynamicAttributes: [ - 'aria-expanded', - 'data-bs-popper', - 'data-bs-target', - 'data-bs-theme', - 'data-dark-mode', - 'data-global-alert', - 'data-pane', // tabs.js - 'data-popper-placement', - 'data-sizes', - 'data-toggle-tab', // tabs.js - 'id', - 'size', - 'type', - ], - safelist: [ - 'active', - 'btn-clipboard', // clipboards.js - 'clipboard', // clipboards.js - 'disabled', - 'hidden', - 'modal-backdrop', // search-modal.js - 'selected', // search-modal.js - 'show', - 'img-fluid', - 'blur-up', - 'lazyload', - 'lazyloaded', - 'alert-link', - 'container-fw ', - 'container-lg', - 'container-fluid', - 'offcanvas-backdrop', - 'figcaption', - 'dt', - 'dd', - 'showing', - 'hiding', - 'page-item', - 'page-link', - ...whitelister([ - './assets/scss/**/*.scss', - './node_modules/@hyas/doks-core/assets/scss/components/_code.scss', - './node_modules/@hyas/doks-core/assets/scss/components/_expressive-code.scss', - './node_modules/@hyas/doks-core/assets/scss/common/_syntax.scss', - ]), - ], - }), - ], -} +const autoprefixer = require('autoprefixer'); +const purgecss = require('@fullhuman/postcss-purgecss'); +const whitelister = require('purgecss-whitelister'); + +module.exports = { + plugins: [ + autoprefixer(), + purgecss({ + content: [ './hugo_stats.json' ], + extractors: [ + { + extractor: (content) => { + const els = JSON.parse(content).htmlElements; + return els.tags.concat(els.classes, els.ids); + }, + extensions: ['json'], + }, + ], + dynamicAttributes: [ + 'aria-expanded', + 'data-bs-popper', + 'data-bs-target', + 'data-bs-theme', + 'data-dark-mode', + 'data-global-alert', + 'data-pane', // tabs.js + 'data-popper-placement', + 'data-sizes', + 'data-toggle-tab', // tabs.js + 'id', + 'size', + 'type', + ], + safelist: [ + 'active', + 'btn-clipboard', // clipboards.js + 'clipboard', // clipboards.js + 'disabled', + 'hidden', + 'modal-backdrop', // search-modal.js + 'selected', // search-modal.js + 'show', + 'img-fluid', + 'blur-up', + 'lazyload', + 'lazyloaded', + 'alert-link', + 'container-fw ', + 'container-lg', + 'container-fluid', + 'offcanvas-backdrop', + 'figcaption', + 'dt', + 'dd', + 'showing', + 'hiding', + 'page-item', + 'page-link', + ...whitelister([ + './assets/scss/**/*.scss', + './node_modules/@hyas/doks-core/assets/scss/components/_code.scss', + './node_modules/@hyas/doks-core/assets/scss/components/_expressive-code.scss', + './node_modules/@hyas/doks-core/assets/scss/common/_syntax.scss', + ]), + ], + }), + ], +} diff --git a/website/config/production/hugo.toml b/website/config/production/hugo.toml index 6ce2a03..ff90f22 100644 --- a/website/config/production/hugo.toml +++ b/website/config/production/hugo.toml @@ -1 +1 @@ -# Overrides for production environment +# Overrides for production environment diff --git a/website/content/_index.md b/website/content/_index.md index 4ef017d..9cb9c3a 100644 --- a/website/content/_index.md +++ b/website/content/_index.md @@ -1,5 +1,5 @@ ---- -title : "Home" ---- - +--- +title : "Home" +--- + Open-source Apache-2.0 Licensed. \ No newline at end of file diff --git a/website/content/blog/_index.md b/website/content/blog/_index.md index a99c1bd..4cd6946 100644 --- a/website/content/blog/_index.md +++ b/website/content/blog/_index.md @@ -1,19 +1,19 @@ ---- -title: "Blog" -description: "" -summary: "" -date: 2023-09-07T16:21:44+02:00 -lastmod: 2023-09-07T16:21:44+02:00 -draft: false -weight: 50 -categories: [] -tags: [] -contributors: [] -pinned: false -homepage: false -seo: - title: "" # custom title (optional) - description: "" # custom description (recommended) - canonical: "" # custom canonical URL (optional) - noindex: false # false (default) or true ---- +--- +title: "Blog" +description: "" +summary: "" +date: 2023-09-07T16:21:44+02:00 +lastmod: 2023-09-07T16:21:44+02:00 +draft: false +weight: 50 +categories: [] +tags: [] +contributors: [] +pinned: false +homepage: false +seo: + title: "" # custom title (optional) + description: "" # custom description (recommended) + canonical: "" # custom canonical URL (optional) + noindex: false # false (default) or true +--- diff --git a/website/content/blog/example/index.md b/website/content/blog/example/index.md index bf3a0e1..a2ddeb1 100644 --- a/website/content/blog/example/index.md +++ b/website/content/blog/example/index.md @@ -1,19 +1,19 @@ ---- -title: "Example Post" -description: "Just an example post." -summary: "" -date: 2023-09-07T16:27:22+02:00 -lastmod: 2023-09-07T16:27:22+02:00 -draft: false -weight: 50 -categories: [] -tags: [] -contributors: [] -pinned: false -homepage: false -seo: - title: "" # custom title (optional) - description: "" # custom description (recommended) - canonical: "" # custom canonical URL (optional) - noindex: false # false (default) or true ---- +--- +title: "Example Post" +description: "Just an example post." +summary: "" +date: 2023-09-07T16:27:22+02:00 +lastmod: 2023-09-07T16:27:22+02:00 +draft: false +weight: 50 +categories: [] +tags: [] +contributors: [] +pinned: false +homepage: false +seo: + title: "" # custom title (optional) + description: "" # custom description (recommended) + canonical: "" # custom canonical URL (optional) + noindex: false # false (default) or true +--- diff --git a/website/content/docs/_index.md b/website/content/docs/_index.md index caddc37..146f780 100644 --- a/website/content/docs/_index.md +++ b/website/content/docs/_index.md @@ -1,3 +1,3 @@ ---- -title: "Docs" ---- +--- +title: "Docs" +--- diff --git a/website/content/privacy.md b/website/content/privacy.md index 5d58953..178d9c1 100644 --- a/website/content/privacy.md +++ b/website/content/privacy.md @@ -1,14 +1,14 @@ ---- -title: "Privacy Policy" -description: "" -summary: "" -date: 2023-09-07T17:19:07+02:00 -lastmod: 2023-09-07T17:19:07+02:00 -draft: false -type: "legal" -seo: - title: "" # custom title (optional) - description: "" # custom description (recommended) - canonical: "" # custom canonical URL (optional) - noindex: false # false (default) or true ---- +--- +title: "Privacy Policy" +description: "" +summary: "" +date: 2023-09-07T17:19:07+02:00 +lastmod: 2023-09-07T17:19:07+02:00 +draft: false +type: "legal" +seo: + title: "" # custom title (optional) + description: "" # custom description (recommended) + canonical: "" # custom canonical URL (optional) + noindex: false # false (default) or true +--- diff --git a/website/layouts/index.html b/website/layouts/index.html index 3ebc565..d5be546 100644 --- a/website/layouts/index.html +++ b/website/layouts/index.html @@ -1,69 +1,69 @@ -{{ define "main" }} -
-
-
- -

Perses

-
-
-

{{ .Params.lead | safeHTML }}

- Getting Started - {{ .Content }} -
-
-
-{{ end }} - -{{ define "sidebar-prefooter" }} -{{ if site.Params.doks.backgroundDots -}} -
-
-
-{{ end -}} -{{ if eq $.Site.Language.LanguageName "English" }} -
-
-
-
-

GitOps Native

-

- Facilitates a seamless "dashboards as code" workflow by introducing an innovative and precisely defined - dashboard definition model. -

-
-
-

Extensible

-

- Perses, with its plugin-based architecture, offers effortless extension and reuse of plugins across different - projects. -

-
-
-

Static Validation

-

- Perses supports hassle-free dashboard-as-code usage with built-in static validation. Validate your dashboard - in CI/CD using the Perses CLI (percli). -

-
-
-
-
-{{ end }} -{{ end }} - -{{ define "sidebar-footer" }} -{{ if site.Params.doks.sectionFooter -}} -
-
-
-

Start building with Doks today

- {{ i18n "get-started" }} -
-
-
-{{ end -}} +{{ define "main" }} +
+
+
+ +

Perses

+
+
+

{{ .Params.lead | safeHTML }}

+ Getting Started + {{ .Content }} +
+
+
+{{ end }} + +{{ define "sidebar-prefooter" }} +{{ if site.Params.doks.backgroundDots -}} +
+
+
+{{ end -}} +{{ if eq $.Site.Language.LanguageName "English" }} +
+
+
+
+

GitOps Native

+

+ Facilitates a seamless "dashboards as code" workflow by introducing an innovative and precisely defined + dashboard definition model. +

+
+
+

Extensible

+

+ Perses, with its plugin-based architecture, offers effortless extension and reuse of plugins across different + projects. +

+
+
+

Static Validation

+

+ Perses supports hassle-free dashboard-as-code usage with built-in static validation. Validate your dashboard + in CI/CD using the Perses CLI (percli). +

+
+
+
+
+{{ end }} +{{ end }} + +{{ define "sidebar-footer" }} +{{ if site.Params.doks.sectionFooter -}} +
+
+
+

Start building with Doks today

+ {{ i18n "get-started" }} +
+
+
+{{ end -}} {{ end }} \ No newline at end of file diff --git a/website/layouts/partials/footer/script-footer-custom.html b/website/layouts/partials/footer/script-footer-custom.html index 4411a70..d570e83 100644 --- a/website/layouts/partials/footer/script-footer-custom.html +++ b/website/layouts/partials/footer/script-footer-custom.html @@ -1,13 +1,13 @@ -{{/* Put your custom tags here */}} - -{{/* EXAMPLE - only load script for production -{{ if eq (hugo.Environment) "production" -}} - {{ partial "footer/esbuild" (dict "src" "js/instantpage.js" "load" "async" "transpile" false) -}} -{{ end -}} -*/}} - -{{/* EXAMPLE - only load script for a page type e.g. contact or gallery -{{ if eq .Type "gallery" -}} - {{ partial "footer/esbuild" (dict "src" "js/gallery.js" "load" "async" "transpile" false) -}} -{{ end -}} -*/}} +{{/* Put your custom tags here */}} + +{{/* EXAMPLE - only load script for production +{{ if eq (hugo.Environment) "production" -}} + {{ partial "footer/esbuild" (dict "src" "js/instantpage.js" "load" "async" "transpile" false) -}} +{{ end -}} +*/}} + +{{/* EXAMPLE - only load script for a page type e.g. contact or gallery +{{ if eq .Type "gallery" -}} + {{ partial "footer/esbuild" (dict "src" "js/gallery.js" "load" "async" "transpile" false) -}} +{{ end -}} +*/}} diff --git a/website/layouts/partials/head/custom-head.html b/website/layouts/partials/head/custom-head.html index 21e7bea..0c59d7f 100644 --- a/website/layouts/partials/head/custom-head.html +++ b/website/layouts/partials/head/custom-head.html @@ -1 +1 @@ - + diff --git a/website/layouts/partials/head/script-header.html b/website/layouts/partials/head/script-header.html index aba9802..ae068e3 100644 --- a/website/layouts/partials/head/script-header.html +++ b/website/layouts/partials/head/script-header.html @@ -1 +1 @@ - +