Merge remote-tracking branch 'upstream/main'

This commit is contained in:
phil 2023-09-08 22:27:27 +02:00
commit a390c6bc50
19 changed files with 1367 additions and 836 deletions

View file

@ -1,252 +0,0 @@
---
kind: pipeline
name: test
platform:
os: linux
arch: amd64
steps:
- name: eslint
image: node:lts
commands:
- npm install > /dev/null
- npm run lint
environment:
FORCE_COLOR: true
NPM_CONFIG_LOGLEVEL: error
- name: assets
image: node:lts
commands:
- npm install > /dev/null
- npm run build
environment:
FORCE_COLOR: true
NPM_CONFIG_LOGLEVEL: error
- name: testbuild
image: thegeeklab/hugo:0.115.2
commands:
- mkdir -p exampleSite/themes/ && ln -s $(pwd)/ exampleSite/themes/hugo-geekdoc
- hugo --panicOnWarning -s exampleSite/ -b http://localhost:8000/
- name: html-validation
image: thegeeklab/vnu
commands:
- vnu --skip-non-html --also-check-css --errors-only --filterfile .vnuignore exampleSite/public
- name: link-validation
image: thegeeklab/link-validator
commands:
- link-validator --color=always --rate-limit 10 -e https://github.com/thegeeklab/hugo-geekdoc/edit/main/.* -e https://unsplash.com.*
environment:
LINK_VALIDATOR_BASE_DIR: exampleSite/public
LINK_VALIDATOR_RETRIES: 3
- name: page-validation
image: thegeeklab/lhci:0.11
commands:
- lhci autorun
environment:
LHCI_SERVER_URL: https://drone-artifact.rknet.org/${DRONE_REPO_NAME}/
trigger:
ref:
- refs/heads/main
- refs/tags/**
- refs/pull/**
---
kind: pipeline
name: build
platform:
os: linux
arch: amd64
steps:
- name: assets
image: node:lts
commands:
- git fetch -tq
- npm install > /dev/null
- npm run build
- cat VERSION
environment:
FORCE_COLOR: true
NPM_CONFIG_LOGLEVEL: error
- name: package
image: node:lts
commands:
- npm run pack
environment:
FORCE_COLOR: true
NPM_CONFIG_LOGLEVEL: error
- name: checksum
image: thegeeklab/alpine-tools
commands:
- cd dist/ && sha256sum * > ../sha256sum.txt
- name: changelog
image: thegeeklab/git-chglog
commands:
- git fetch -tq
- git-chglog --no-color --no-emoji ${DRONE_TAG:---next-tag unreleased unreleased}
- git-chglog --no-color --no-emoji -o CHANGELOG.md ${DRONE_TAG:---next-tag unreleased unreleased}
- name: release
image: plugins/github-release
settings:
api_key:
from_secret: github_token
files:
- dist/*
- sha256sum.txt
note: CHANGELOG.md
overwrite: true
title: ${DRONE_TAG}
when:
ref:
- refs/tags/**
trigger:
ref:
- refs/heads/main
- refs/tags/**
- refs/pull/**
depends_on:
- test
---
kind: pipeline
name: docs
platform:
os: linux
arch: amd64
concurrency:
limit: 1
steps:
- name: markdownlint
image: thegeeklab/markdownlint-cli
commands:
- markdownlint 'exampleSite/content/**/*.md' 'README.md'
- name: spellcheck
image: thegeeklab/alpine-tools
commands:
- spellchecker --files 'exampleSite/content/**/*.md' 'README.md' -d .dictionary -p spell indefinite-article syntax-urls frontmatter --frontmatter-keys title --no-suggestions
environment:
FORCE_COLOR: true
NPM_CONFIG_LOGLEVEL: error
- name: assets
image: node:lts
commands:
- npm install > /dev/null
- npm run svg-sprite-list
- mkdir -p exampleSite/themes/hugo-geekdoc/
- curl -sSL https://github.com/thegeeklab/hugo-geekdoc/releases/latest/download/hugo-geekdoc.tar.gz | tar -xz -C exampleSite/themes/hugo-geekdoc/ --strip-components=1
when:
ref:
- refs/heads/main
- refs/tags/**
- name: assets-main
image: node:lts
commands:
- npm install > /dev/null
- npm run build
- npm run svg-sprite-list
- mkdir -p exampleSite/themes/ && ln -s $(pwd)/ exampleSite/themes/hugo-geekdoc
environment:
FORCE_COLOR: true
NPM_CONFIG_LOGLEVEL: error
when:
ref:
- refs/pull/**
- name: build
image: thegeeklab/hugo:0.115.2
commands:
- hugo --panicOnWarning -s exampleSite/
- name: beautify
image: thegeeklab/alpine-tools
commands:
- html-beautify -r -f 'exampleSite/public/**/*.html'
environment:
FORCE_COLOR: true
NPM_CONFIG_LOGLEVEL: error
- name: publish
image: thegeeklab/drone-s3-sync:2
settings:
access_key:
from_secret: s3_access_key
bucket: geekdocs-root
delete: true
endpoint: https://sp.rknet.org
path_style: true
secret_key:
from_secret: s3_secret_access_key
source: exampleSite/public/
strip_prefix: exampleSite/public/
when:
ref:
- refs/heads/main
- refs/tags/**
trigger:
ref:
- refs/heads/main
- refs/tags/**
- refs/pull/**
depends_on:
- build
---
kind: pipeline
name: notifications
platform:
os: linux
arch: amd64
steps:
- name: matrix
image: thegeeklab/drone-matrix
settings:
homeserver:
from_secret: matrix_homeserver
password:
from_secret: matrix_password
roomid:
from_secret: matrix_roomid
template: "Status: **{{ .Build.Status }}**<br/> Build: [{{ .Repo.Owner }}/{{ .Repo.Name }}]({{ .Build.Link }}){{ if .Build.Branch }} ({{ .Build.Branch }}){{ end }} by {{ .Commit.Author }}<br/> Message: {{ .Commit.Message.Title }}"
username:
from_secret: matrix_username
when:
status:
- success
- failure
trigger:
ref:
- refs/heads/main
- refs/tags/**
status:
- success
- failure
depends_on:
- test
- build
- docs

View file

@ -52,7 +52,9 @@ branches:
required_status_checks:
strict: false
contexts:
- continuous-integration/drone/pr
enforce_admins: true
- ci/woodpecker/pr/test
- ci/woodpecker/pr/build-package
- ci/woodpecker/pr/docs
enforce_admins: false
required_linear_history: true
restrictions: null

View file

@ -9,16 +9,20 @@ ci:
- http://localhost/usage/getting-started/
settings:
chromeFlags: "--no-sandbox"
onlyCategories: ['performance', 'accessibility', 'best-practices', 'seo']
skipAudits: ["color-contrast", "uses-long-cache-ttl", "csp-xss", "bf-cache", "is-crawlable", "image-size-responsive"]
assert:
preset: "lighthouse:no-pwa"
assertions:
color-contrast: off
uses-long-cache-ttl: off
csp-xss: off
# FIXME: https://github.com/GoogleChrome/lighthouse/issues/14957
bf-cache: off
is-crawlable: off
image-size-responsive: off
tap-targets: warn
unsized-images: warn
image-size-responsive: warn
# FIXME: https://github.com/GoogleChrome/lighthouse/issues/11460
categories:performance:
- warn

View file

@ -1,4 +1,3 @@
.drone.yml
_normalize.css
list.json.json
/.lighthouseci/

View file

@ -3,7 +3,7 @@
.tarignore
.dictionary*
.git*
.drone*
.woodpecker*
.lighthouse*
.markdownlint*
.jsbeautify*

View file

@ -0,0 +1,60 @@
---
when:
- event: [pull_request, tag]
- event: [push, manual]
branch:
- ${CI_REPO_DEFAULT_BRANCH}
steps:
assets:
image: docker.io/library/node:lts
commands:
- git fetch -tq
- npm install > /dev/null
- npm run build
- cat VERSION
environment:
FORCE_COLOR: "true"
NPM_CONFIG_LOGLEVEL: error
package:
image: docker.io/library/node:lts
commands:
- npm run pack
environment:
FORCE_COLOR: "true"
NPM_CONFIG_LOGLEVEL: error
checksum:
image: quay.io/thegeeklab/alpine-tools
commands:
- cd dist/ && sha256sum * > ../sha256sum.txt
changelog-generate:
image: quay.io/thegeeklab/git-chglog
commands:
- git fetch -tq
- git-chglog --no-color --no-emoji -o CHANGELOG.md ${CI_COMMIT_TAG:---next-tag unreleased unreleased}
changelog-format:
image: quay.io/thegeeklab/alpine-tools
commands:
- prettier CHANGELOG.md
- prettier -w CHANGELOG.md
publish-github:
image: docker.io/plugins/github-release
settings:
api_key:
from_secret: github_token
files:
- dist/*
- sha256sum.txt
note: CHANGELOG.md
overwrite: true
title: ${CI_COMMIT_TAG}
when:
- event: [tag]
depends_on:
- test

81
.woodpecker/docs.yml Normal file
View file

@ -0,0 +1,81 @@
---
when:
- event: [pull_request, tag]
- event: [push, manual]
branch:
- ${CI_REPO_DEFAULT_BRANCH}
steps:
markdownlint:
image: quay.io/thegeeklab/markdownlint-cli
commands:
- markdownlint 'exampleSite/content/**/*.md' 'README.md' 'CONTRIBUTING.md'
spellcheck:
image: quay.io/thegeeklab/alpine-tools
commands:
- spellchecker --files 'exampleSite/content/**/*.md' 'README.md' -d .dictionary -p spell indefinite-article syntax-urls frontmatter --frontmatter-keys title
environment:
FORCE_COLOR: "true"
NPM_CONFIG_LOGLEVEL: error
assets:
image: docker.io/library/node:lts
commands:
- npm install > /dev/null
- npm run svg-sprite-list
- mkdir -p exampleSite/themes/${CI_REPO_NAME}
- curl -sSL https://github.com/${CI_REPO}/releases/latest/download/${CI_REPO_NAME}.tar.gz | tar -xz -C exampleSite/themes/${CI_REPO_NAME}/ --strip-components=1
when:
- event: [tag]
- event: [push, manual]
branch:
- ${CI_REPO_DEFAULT_BRANCH}
assets-main:
image: docker.io/library/node:lts
commands:
- npm install > /dev/null
- npm run build
- npm run svg-sprite-list
- mkdir -p exampleSite/themes/ && ln -s $(pwd)/ exampleSite/themes/${CI_REPO_NAME}
environment:
FORCE_COLOR: "true"
NPM_CONFIG_LOGLEVEL: error
when:
- event: [pull_request]
build:
image: quay.io/thegeeklab/hugo:0.115.2
commands:
- hugo --panicOnWarning -s exampleSite/
beautify:
image: quay.io/thegeeklab/alpine-tools
commands:
- html-beautify -r -f 'exampleSite/public/**/*.html'
environment:
FORCE_COLOR: "true"
NPM_CONFIG_LOGLEVEL: error
publish:
image: quay.io/thegeeklab/wp-s3-action
settings:
access_key:
from_secret: s3_access_key
bucket: geekdocs-root
delete: true
endpoint: https://sp.rknet.org
path_style: true
secret_key:
from_secret: s3_secret_access_key
source: exampleSite/public/
strip_prefix: exampleSite/public/
when:
- event: [tag]
- event: [push, manual]
branch:
- ${CI_REPO_DEFAULT_BRANCH}
depends_on:
- build-package

26
.woodpecker/notify.yml Normal file
View file

@ -0,0 +1,26 @@
---
when:
- event: [tag]
- event: [push, manual]
branch:
- ${CI_REPO_DEFAULT_BRANCH}
runs_on: [success, failure]
steps:
matrix:
image: quay.io/thegeeklab/wp-matrix
settings:
homeserver:
from_secret: matrix_homeserver
password:
from_secret: matrix_password
roomid:
from_secret: matrix_roomid
username:
from_secret: matrix_username
when:
- status: [success, failure]
depends_on:
- docs

54
.woodpecker/test.yml Normal file
View file

@ -0,0 +1,54 @@
---
when:
- event: [pull_request, tag]
- event: [push, manual]
branch:
- ${CI_REPO_DEFAULT_BRANCH}
steps:
eslint:
image: docker.io/library/node:lts
commands:
- npm install > /dev/null
- npm run lint
environment:
FORCE_COLOR: "true"
NPM_CONFIG_LOGLEVEL: error
assets:
image: docker.io/library/node:lts
commands:
- npm install > /dev/null
- npm run build
environment:
FORCE_COLOR: "true"
NPM_CONFIG_LOGLEVEL: error
testbuild:
image: quay.io/thegeeklab/hugo:0.115.2
commands:
- mkdir -p exampleSite/themes/ && ln -s $(pwd)/ exampleSite/themes/${CI_REPO_NAME}
- hugo --panicOnWarning -s exampleSite/ -b http://localhost:8000/
html-validation:
image: quay.io/thegeeklab/vnu
group: test
commands:
- vnu --skip-non-html --also-check-css --errors-only --filterfile .vnuignore exampleSite/public
link-validation:
image: quay.io/thegeeklab/link-validator
group: test
commands:
- link-validator --color=always --rate-limit 10 --timeout 60 -e https://github.com/thegeeklab/${CI_REPO_NAME}/edit/main/.* -e https://unsplash.com.*
environment:
LINK_VALIDATOR_BASE_DIR: exampleSite/public
LINK_VALIDATOR_RETRIES: "3"
page-validation:
image: quay.io/thegeeklab/lhci:0.12
group: test
commands:
- lhci autorun
environment:
LHCI_SERVER_URL: https://drone-artifact.rknet.org/${CI_REPO_NAME}/

View file

@ -1,6 +1,6 @@
# Geekdoc
[![Build Status](https://img.shields.io/drone/build/thegeeklab/hugo-geekdoc?logo=drone&server=https%3A%2F%2Fdrone.thegeeklab.de)](https://drone.thegeeklab.de/thegeeklab/hugo-geekdoc)
[![Build Status](https://ci.thegeeklab.de/api/badges/thegeeklab/hugo-geekdoc/status.svg)](https://ci.thegeeklab.de/repos/thegeeklab/hugo-geekdoc)
[![Hugo Version](https://img.shields.io/badge/hugo-0.112-blue.svg)](https://gohugo.io)
[![GitHub release](https://img.shields.io/github/v/release/thegeeklab/hugo-geekdoc)](https://github.com/thegeeklab/hugo-geekdoc/releases/latest)
[![GitHub contributors](https://img.shields.io/github/contributors/thegeeklab/hugo-geekdoc)](https://github.com/thegeeklab/hugo-geekdoc/graphs/contributors)

View file

@ -8,7 +8,7 @@ geekdocAnchor: false
<!-- markdownlint-capture -->
<!-- markdownlint-disable MD033 -->
<span class="badge-placeholder">[![Build Status](https://img.shields.io/drone/build/thegeeklab/hugo-geekdoc?logo=drone&server=https%3A%2F%2Fdrone.thegeeklab.de)](https://drone.thegeeklab.de/thegeeklab/hugo-geekdoc)</span>
<span class="badge-placeholder">[![Build Status](https://ci.thegeeklab.de/api/badges/thegeeklab/hugo-geekdoc/status.svg)](https://ci.thegeeklab.de/repos/thegeeklab/hugo-geekdoc)</span>
<span class="badge-placeholder">[![Hugo Version](https://img.shields.io/badge/hugo-0.112-blue.svg)](https://gohugo.io)</span>
<span class="badge-placeholder">[![GitHub release](https://img.shields.io/github/v/release/thegeeklab/hugo-geekdoc)](https://github.com/thegeeklab/hugo-geekdoc/releases/latest)</span>
<span class="badge-placeholder">[![GitHub contributors](https://img.shields.io/github/contributors/thegeeklab/hugo-geekdoc)](https://github.com/thegeeklab/hugo-geekdoc/graphs/contributors)</span>

View file

@ -3,16 +3,16 @@
<!-- prettier-ignore-start -->
{{- if $showAnchor -}}
<div class="gdoc-page__anchorwrap">
<div class="flex align-center gdoc-page__anchorwrap">
<h{{ .Level }} id="{{ .Anchor | safeURL }}" {{- with .Attributes.class }}
class="{{ . }}"
{{- end }}
>
{{ .Text | safeHTML }}
</h{{ .Level }}>
<a data-clipboard-text="{{ .Page.Permalink }}#{{ .Anchor | safeURL }}" class="gdoc-page__anchor clip flex align-center" title="{{ i18n "title_anchor_prefix" }} {{ .Text | safeHTML }}" aria-label="{{ i18n "title_anchor_prefix" }} {{ .Text | safeHTML }}" href="#{{ .Anchor | safeURL }}">
<svg class="gdoc-icon gdoc_link"><use xlink:href="#gdoc_link"></use></svg>
</a>
</h{{ .Level }}>
</div>
{{- else -}}
<div class="gdoc-page__anchorwrap">

View file

@ -1,6 +1,7 @@
{{- $name := .Get "name" -}}
{{- $sort := .Get "sort" -}}
{{- $order := default "asc" (.Get "order") -}}
{{- $showAnchor := (and (default true .Page.Params.geekdocAnchor) (default true .Page.Site.Params.geekdocAnchor)) -}}
{{- if .Site.Data.properties }}
<dl class="gdoc-props">
@ -10,11 +11,11 @@
{{- $properties = (sort $properties . $order) }}
{{- end }}
{{- range $properties }}
<dt class="flex flex-wrap align-center gdoc-props__meta">
<dt class="flex flex-wrap align-center gdoc-props__meta"{{ if $showAnchor }} id="{{ anchorize .name }}"{{ end }}>
<span class="gdoc-props__title">{{ .name }}</span>
{{- if .required }}
<span class="gdoc-props__tag warning">{{ i18n "propertylist_required" | lower }}</span>
{{ else }}
{{- else }}
<span class="gdoc-props__tag tip">{{ i18n "propertylist_optional" | lower }}</span>
{{- end }}
{{- with .type }}
@ -30,6 +31,11 @@
<span class="gdoc-props__tag">{{ . }}</span>
{{- end }}
{{- end }}
{{- if $showAnchor }}
<a data-clipboard-text="{{ .Page.Permalink }}#{{ anchorize .name | safeHTML }}" class="gdoc-page__anchor clip flex align-center" title="{{ i18n "title_anchor_prefix" }} {{ .name | safeHTML }}" aria-label="{{ i18n "title_anchor_prefix" }} {{ .name | safeHTML }}" href="#{{ anchorize .name | safeHTML }}">
<svg class="gdoc-icon gdoc_link"><use xlink:href="#gdoc_link"></use></svg>
</a>
{{- end }}
</dt>
<dd>
<div class="gdoc-props__description">
@ -38,9 +44,8 @@
{{- if reflect.IsMap $desc }}
{{- $desc = (index $desc $.Site.Language.Lang) }}
{{- end }}
{{ $desc | $.Page.RenderString }}
{{ end }}
{{- end }}
</div>
<div class="gdoc-props__default">
{{- with default "none" (.defaultValue | string) }}

1619
package-lock.json generated

File diff suppressed because it is too large Load diff

View file

@ -31,37 +31,37 @@
"node": ">=16.15 <=18"
},
"dependencies": {
"@cfworker/json-schema": "1.12.5",
"@cfworker/json-schema": "1.12.7",
"clipboard": "2.0.11",
"flexsearch": "0.7.31",
"katex": "0.16.8",
"lodash": "4.17.21",
"mermaid": "10.2.4",
"mermaid": "10.4.0",
"store2": "2.14.2"
},
"devDependencies": {
"@babel/eslint-parser": "7.22.7",
"@babel/eslint-parser": "7.22.11",
"@eloquent/git-version-webpack-plugin": "5.0.1",
"autoprefixer": "10.4.14",
"autoprefixer": "10.4.15",
"copy-webpack-plugin": "11.0.0",
"css-loader": "6.8.1",
"eslint": "8.44.0",
"eslint-config-prettier": "8.8.0",
"eslint": "8.48.0",
"eslint-config-prettier": "9.0.0",
"eslint-plugin-prettier": "5.0.0",
"favicons": "7.1.3",
"favicons": "7.1.4",
"npm-run-all": "4.1.5",
"postcss-loader": "7.3.3",
"prettier": "3.0.0",
"sass": "1.63.6",
"prettier": "3.0.3",
"sass": "1.66.1",
"sass-loader": "13.3.2",
"shx": "0.3.4",
"svg-sprite": "2.0.2",
"svgtofont": "3.25.4",
"webpack": "5.88.1",
"svgtofont": "4.0.0",
"webpack": "5.88.2",
"webpack-cli": "5.1.4",
"webpack-favicons": "1.3.8",
"webpack-manifest-plugin": "5.0.0",
"webpack-remove-empty-scripts": "1.0.3"
"webpack-remove-empty-scripts": "1.0.4"
},
"overrides": {
"colors": "1.4.0"

View file

@ -8,12 +8,12 @@ document.addEventListener("DOMContentLoaded", function (event) {
const trigger = e.trigger
if (trigger.hasAttribute("data-copy-feedback")) {
trigger.classList.add("gdoc-post__codecopy--success")
trigger.classList.add("gdoc-post__codecopy--success", "gdoc-post__codecopy--out")
trigger.querySelector(".gdoc-icon.copy").classList.add("hidden")
trigger.querySelector(".gdoc-icon.check").classList.remove("hidden")
setTimeout(function () {
trigger.classList.remove("gdoc-post__codecopy--success")
trigger.classList.remove("gdoc-post__codecopy--success", "gdoc-post__codecopy--out")
trigger.querySelector(".gdoc-icon.copy").classList.remove("hidden")
trigger.querySelector(".gdoc-icon.check").classList.add("hidden")
}, 3000)

View file

@ -365,7 +365,9 @@ svg.gdoc-icon {
.gdoc-language__list {
background: var(--body-background);
border-radius: $border-radius;
box-shadow: 0 1px 3px 0 var(--accent-color-dark), 0 1px 2px 0 var(--accent-color);
box-shadow:
0 1px 3px 0 var(--accent-color-dark),
0 1px 2px 0 var(--accent-color);
position: absolute;
margin: 0;
padding: $padding-8 $padding-4 !important;
@ -421,17 +423,17 @@ svg.gdoc-icon {
}
&__anchorwrap {
gap: 0.5em;
&:hover .gdoc-page__anchor svg.gdoc-icon {
color: var(--control-icons);
}
}
&__anchor {
margin-left: $padding-8;
svg.gdoc-icon {
width: 1.25em;
height: 1.25em;
width: 1.85em;
height: 1.85em;
color: transparent;
}
@ -564,6 +566,10 @@ svg.gdoc-icon {
color: var(--code-copy-success-color);
}
}
&--out {
transition: visibility 2s ease-out;
}
}
}
@ -614,7 +620,9 @@ svg.gdoc-icon {
padding: $padding-8;
padding-left: $padding-32;
transition: border-color 0.15s ease-in-out, box-shadow 0.15s ease-in-out;
transition:
border-color 0.15s ease-in-out,
box-shadow 0.15s ease-in-out;
border: 1px solid transparent;
border-radius: $border-radius;
@ -685,7 +693,7 @@ svg.gdoc-icon {
}
&:focus-within &__list.has-hits,
&__list.has-hits:active {
&__list.has-hits:hover {
visibility: visible;
}
}

View file

@ -128,9 +128,9 @@
--code-accent-color-lite: #{darken($code-background-dark, 2)};
--code-font-color: #{$code-font-color-dark};
--code-copy-background: #{$body-background-dark};
--code-copy-font-color: #{lighten($body-font-color, 24)};
--code-copy-border-color: #{lighten($body-font-color, 24)};
--code-copy-background: #{$code-background-dark};
--code-copy-font-color: #{darken($code-font-color-dark, 15)};
--code-copy-border-color: #{darken($code-font-color-dark, 20)};
--code-copy-success-color: #{scale-color(map.get($hint-colors, "ok"), $alpha: -55%)};
}
@ -143,7 +143,7 @@
--code-font-color: #{$code-font-color};
--code-copy-background: #{$code-background};
--code-copy-font-color: #{lighten($body-font-color, 24)};
--code-copy-border-color: #{lighten($body-font-color, 48)};
--code-copy-font-color: #{lighten($code-font-color, 15)};
--code-copy-border-color: #{lighten($code-font-color, 20)};
--code-copy-success-color: #{map.get($hint-colors, "ok")};
}

View file

@ -209,17 +209,18 @@
.gdoc-props {
&__title,
&__default {
padding: 0;
margin: 0;
font-family: "Liberation Mono", monospace;
}
&__meta {
gap: 0.5em;
line-height: normal;
margin-bottom: $padding-4;
> span {
margin-bottom: $padding-2;
&:not(:last-child) {
margin-right: $padding-8;
}
&:hover .gdoc-page__anchor svg.gdoc-icon {
color: var(--control-icons);
}
}