Merge remote-tracking branch 'upstream/main' into upstream

This commit is contained in:
phil 2023-07-14 07:54:27 +02:00
commit 95632a5aff
44 changed files with 2699 additions and 1489 deletions

View file

@ -26,7 +26,7 @@ steps:
NPM_CONFIG_LOGLEVEL: error
- name: testbuild
image: thegeeklab/hugo:0.105.0
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/
@ -51,40 +51,6 @@ steps:
environment:
LHCI_SERVER_URL: https://drone-artifact.rknet.org/${DRONE_REPO_NAME}/
- name: page-validation-upload
image: thegeeklab/drone-s3-sync:2
settings:
access_key:
from_secret: s3_access_key
bucket: drone-artifact
endpoint: https://sp.rknet.org
path_style: true
secret_key:
from_secret: s3_secret_access_key
source: lhci_reports/dist/
strip_prefix: lhci_reports/dist/
target: /${DRONE_REPO_NAME}
when:
status:
- failure
- success
- name: page-validation-link
image: thegeeklab/drone-github-comment
settings:
api_key:
from_secret: github_token
key: pr-${DRONE_PULL_REQUEST}
message: lhci_reports/dist/summary.md
skip_missing: true
update: true
when:
ref:
- refs/pull/**
status:
- failure
- success
trigger:
ref:
- refs/heads/main
@ -207,7 +173,7 @@ steps:
- refs/pull/**
- name: build
image: thegeeklab/hugo:0.105.0
image: thegeeklab/hugo:0.115.2
commands:
- hugo --panicOnWarning -s exampleSite/
@ -284,9 +250,3 @@ depends_on:
- test
- build
- docs
---
kind: signature
hmac: da9896c5892fff7425a4594cea8576d065aeacae177ffa2d411782721e61a1fb
...

View file

@ -6,3 +6,4 @@ list.json.json
/static/js/
/src/favicon/
LICENSE
**/*.html

View file

@ -2,13 +2,5 @@
"printWidth": 99,
"singleQuote": false,
"semi": false,
"trailingComma": "none",
"overrides": [
{
"files": ["*.html"],
"options": {
"parser": "go-template"
}
}
]
"trailingComma": "none"
}

View file

@ -3,7 +3,7 @@
## Security
If you think you have found a **security issue**, please do not mention it in this repository.
Instead, send an email to security@thegeeklab.de with as many details as possible so it can be handled confidential.
Instead, send an email to `security@thegeeklab.de` with as many details as possible so it can be handled confidential.
## Bug Reports and Feature Requests

View file

@ -1,7 +1,7 @@
# 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)
[![Hugo Version](https://img.shields.io/badge/hugo-0.93-blue.svg)](https://gohugo.io)
[![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)
[![License: MIT](https://img.shields.io/github/license/thegeeklab/hugo-geekdoc)](https://github.com/thegeeklab/hugo-geekdoc/blob/main/LICENSE)
@ -16,7 +16,7 @@ This theme is subject to a CI driven build and release process common for softwa
Due to the fact that `webpack` and `npm scripts` are used as pre-processors, the theme cannot be used from the main branch by default. If you want to use the theme from a cloned branch instead of a release tarball you'll need to install `webpack` locally and run the build script once to create all required assets.
```Shell
```shell
# install required packages from package.json
npm install

View file

@ -2,7 +2,7 @@
{{- $searchData := resources.Get "search/data.json" | resources.ExecuteAsTemplate $searchDataFile . | resources.Minify -}}
{
"dataFile": {{ $searchData.RelPermalink | jsonify }},
"indexConfig": {{ .Site.Params.GeekdocSearchConfig | jsonify }},
"showParent": {{ if .Site.Params.GeekdocSearchShowParent }}true{{ else }}false{{ end }},
"showDescription": {{ if .Site.Params.GeekdocSearchshowDescription }}true{{ else }}false{{ end }}
"indexConfig": {{ .Site.Params.geekdocSearchConfig | jsonify }},
"showParent": {{ if .Site.Params.geekdocSearchShowParent }}true{{ else }}false{{ end }},
"showDescription": {{ if .Site.Params.geekdocSearchshowDescription }}true{{ else }}false{{ end }}
}

View file

@ -1,5 +1,5 @@
[
{{ range $index, $page := (where .Site.Pages "Params.GeekdocProtected" "ne" true) }}
{{ range $index, $page := (where .Site.Pages "Params.geekdocProtected" "ne" true) }}
{{ if ne $index 0 }},{{ end }}
{
"id": {{ $index }},

View file

@ -1,3 +1,3 @@
---
GeekdocHidden: true
geekdocHidden: true
---

View file

@ -9,7 +9,7 @@ geekdocAnchor: false
<!-- 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">[![Hugo Version](https://img.shields.io/badge/hugo-0.93-blue.svg)](https://gohugo.io)</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>
<span class="badge-placeholder">[![License: MIT](https://img.shields.io/github/license/thegeeklab/hugo-geekdoc)](https://github.com/thegeeklab/hugo-geekdoc/blob/main/LICENSE)</span>

View file

@ -21,21 +21,21 @@ To display an inline shortcode use single quotes:
Code blocks can be uses without language specification:
````markdown
```Plain
```plain
some code
```
````
**Example:**
```Plain
```plain
some code
```
... or if you need language specific syntax highlighting:
````markdown
```Shell
```shell
# some code
echo "Hello world"
```
@ -43,7 +43,7 @@ echo "Hello world"
**Example:**
```Shell
```shell
# some code
echo "Hello World"
```
@ -55,7 +55,7 @@ Hugo has a build-in shortcode for syntax highlighting. To work properly with thi
{{< tabs "uniqueid" >}}
{{< tab "TOML" >}}
```TOML
```toml
pygmentsUseClasses=true
pygmentsCodeFences=true
```
@ -63,7 +63,7 @@ pygmentsCodeFences=true
{{< /tab >}}
{{< tab "YAML" >}}
```YAML
```yaml
pygmentsUseClasses: true
pygmentsCodeFences: true
```

View file

@ -16,7 +16,7 @@ Regardless of which tool (or existing sprite) you choose, there are a few requir
The result of a valid minimal SVG sprite file could look like this:
```XML
```xml
<svg class="svg-sprite" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink">
<symbol viewBox="-2.29 -2.29 28.57 28.57" id="arrow_back" xmlns="http://www.w3.org/2000/svg">
<path d="M24 10.526v2.947H5.755l8.351 8.421-2.105 2.105-12-12 12-12 2.105 2.105-8.351 8.421H24z"/>
@ -28,7 +28,7 @@ The result of a valid minimal SVG sprite file could look like this:
FontAwesome provides three pre-build sprites included in the regular Web download pack, `sprites/brands.svg`, `sprites/regular.svg` and `sprites/solid.svg`. Choose your sprite to use and copy it to your projects root directory into `assets/sprites`, right beside your `content` folder:
```Bash
```bash
my_projcet/
├── assets
│   └── sprites

View file

@ -12,7 +12,7 @@ Hugo supports the creation of websites with multiple languages. In this post we
You need to set a default language and configure at least two different languages used by your site to your configuration file at `config.toml`:
```Toml
```toml
defaultContentLanguage = "en"
[languages.en]
@ -34,7 +34,7 @@ To customize translation strings used by the theme you can create a file `i18n/<
For the [Bundle Menu](/usage/menus/#bundle-menu) as well as for the [Extra Header Menu](/usage/menus/#extra-header-menu) you can translate the name within the data file of the menu:
```YAML
```yaml
---
more:
# If `name` is a text, this text will be used as name for each language.

View file

@ -13,5 +13,10 @@ Buttons are styled links that can lead to local page or external link.
## Example
<!-- prettier-ignore-start -->
<!-- markdownlint-capture -->
<!-- markdownlint-disable -->
{{< button relref="/" >}}Get Home{{< /button >}}
{{< button href="https://github.com/thegeeklab/hugo-geekdoc" >}}Contribute{{< /button >}}
<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->

View file

@ -78,13 +78,13 @@ HTML content will be filtered by the `safeHTML` filter and added to the rendered
In some situations, it can be helpful to include Markdown files that also contain shortcodes. While the [default method](#markdown-file-default) works fine to render plain Markdown, shortcodes are not parsed. The only way to get this to work is to use Hugo pages. There are several ways to structure these include pages, so whatever you do, keep in mind that Hugo needs to be able to render and serve these files as regular pages! How it works:
1. First you need to create a directory **within** your content directory. For this example site `_includes` is used.
2. To prevent the theme from embedding the page in the navigation, create a file `_includes/_index.md` and add `GeekdocHidden: true` to the front matter.
2. To prevent the theme from embedding the page in the navigation, create a file `_includes/_index.md` and add `geekdocHidden: true` to the front matter.
3. Place your Markdown files within the `_includes` folder e.g. `/_includes/include-page.md`. Make sure to name it `*.md`.
4. Include the page using `{{</* include file="/_includes/include-page.md" type="page" */>}}`.
Resulting structure should look like this:
```Shell
```shell
_includes/
├── include-page.md
└── _index.md

View file

@ -10,7 +10,7 @@ weight: -10
{{< tabs "site-config" >}}
{{< tab "TOML" >}}
```Toml
```toml
baseURL = "http://localhost"
title = "Geekdocs"
theme = "hugo-geekdoc"
@ -65,7 +65,7 @@ enableRobotsTXT = true
# You can also specify this parameter per page in front matter.
geekdocRepo = "https://github.com/thegeeklab/hugo"
# (Optional, default none) Enable 'Edit page' links. Requires 'GeekdocRepo' param
# (Optional, default none) Enable 'Edit page' links. Requires 'geekdocRepo' param
# and the path must point to the parent directory of the 'content' folder.
# You can also specify this parameter per page in front matter.
geekdocEditPath = "edit/main/exampleSite"
@ -134,7 +134,7 @@ enableRobotsTXT = true
{{< /tab >}}
{{< tab "YAML" >}}
```Yaml
```yaml
---
baseURL: "http://localhost"
title: "Geekdocs"
@ -191,7 +191,7 @@ params:
# You can also specify this parameter per page in front matter.
geekdocRepo: "https://github.com/thegeeklab/hugo-geekdoc"
# (Optional, default none) Enable 'Edit page' links. Requires 'GeekdocRepo' param
# (Optional, default none) Enable 'Edit page' links. Requires 'geekdocRepo' param
# and the path must point to the parent directory of the 'content' folder.
# You can also specify this parameter per page in front matter.
geekdocEditPath: edit/main/exampleSite
@ -265,11 +265,13 @@ params:
{{< tabs "page-config" >}}
{{< tab "TOML" >}}
```Toml
```toml
# Set type to 'posts' if you want to render page as blogpost
type = "posts"
# Set page weight to re-arrange items in file-tree menu.
# Hugo predefined front matter variable, to re-arrange items in file-tree menu
# See weights section of
# https://gohugo.io/content-management/front-matter/#predefined
weight = 10
# Set how many table of contents levels to be showed on page.
@ -288,7 +290,7 @@ geekdocBreadcrumb = false
# Set source repository location.
geekdocRepo = "https://github.com/thegeeklab/hugo-geekdoc"
# Enable 'Edit page' links. Requires 'GeekdocRepo' param and the path must point to
# Enable 'Edit page' links. Requires 'geekdocRepo' param and the path must point to
# the parent directory of the 'content' folder.
geekdocEditPath = "edit/main/exampleSite"
@ -325,7 +327,7 @@ geekdocAlign = "left"
{{< /tab >}}
{{< tab "YAML" >}}
```Yaml
```yaml
# Set type to 'posts' if you want to render page as blogpost.
type: "posts"
@ -348,7 +350,7 @@ geekdocBreadcrumb: false
# Set source repository location.
geekdocRepo: "https://github.com/thegeeklab/hugo-geekdoc"
# Enable 'Edit page' links. Requires 'GeekdocRepo' param and the path must point to
# Enable 'Edit page' links. Requires 'geekdocRepo' param and the path must point to
# the parent directory of the 'content' folder.
geekdocEditPath: "edit/main/exampleSite"

View file

@ -15,7 +15,7 @@ You need a recent version of Hugo for local builds and previews of sites that us
If you want to use the theme from a cloned branch instead of a release tarball you'll need to install `webpack` locally and run the build script once to create all required assets.
```Shell
```shell
# install required packages from package.json
npm install
@ -32,13 +32,13 @@ To prepare your new site environment just a few steps are required:
1. Create a new empty Hugo site.
```Shell
```shell
hugo new site demosite
```
2. Switch to the root of the new site.
```Shell
```shell
cd demosite
```
@ -46,7 +46,7 @@ To prepare your new site environment just a few steps are required:
4. Create the minimal required Hugo configuration `config.toml`. For all configuration options take a look at the [configuration](/usage/configuration/) page.
```Toml
```toml
baseURL = "http://localhost"
title = "Geekdocs"
theme = "hugo-geekdoc"
@ -76,7 +76,7 @@ To prepare your new site environment just a few steps are required:
5. Test your site.
```Shell
```shell
hugo server -D
```
@ -84,7 +84,7 @@ To prepare your new site environment just a few steps are required:
Download and extract the latest release bundle into the theme directory.
```Shell
```shell
mkdir -p themes/hugo-geekdoc/
curl -L https://github.com/thegeeklab/hugo-geekdoc/releases/latest/download/hugo-geekdoc.tar.gz | tar -xz -C themes/hugo-geekdoc/ --strip-components=1
```
@ -100,13 +100,13 @@ run the described steps as well.
Clone the Geekdoc git repository.
```Shell
```shell
git clone https://github.com/thegeeklab/hugo-geekdoc.git themes/hugo-geekdoc
```
Build required theme assets e.g. CSS files and SVG sprites.
```Shell
```shell
npm install
npm run build
```
@ -123,7 +123,7 @@ Here are some possible solutions:
Add a Makefile to your repository to bundle the required steps.
```Makefile
```makefile
THEME_VERSION := v0.8.2
THEME := hugo-geekdoc
BASEDIR := docs

View file

@ -35,7 +35,7 @@ This type of navigation needs to be enabled first by setting `geekdocMenuBundle`
**Example:**
```YAML
```yaml
---
main:
- name: Level 1
@ -77,7 +77,7 @@ As this is a special type of the bundle menu it is basically working in the same
**Example:**
```YAML
```yaml
---
more:
- name: News
@ -99,7 +99,7 @@ If you want to customize the header menu, this can be achieved by using a data f
**Example:**
```Yaml
```yaml
---
header:
- name: GitHub

File diff suppressed because one or more lines are too long

After

Width:  |  Height:  |  Size: 20 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 31 KiB

After

Width:  |  Height:  |  Size: 30 KiB

53
i18n/es.yaml Normal file
View file

@ -0,0 +1,53 @@
---
edit_page: Editar página
nav_navigation: Navegación
nav_tags: Etiquetas
nav_more: Más
nav_top: Inicio de la página
form_placeholder_search: Buscar
error_page_title: Perdido? No te preocupes
error_message_title: Perdido?
error_message_code: Error 404
error_message_text: >
Al parecer, lo que estás buscando no pudo ser encontrado. No te preocupes, podemos
llevarte de vuelta al <a class="gdoc-error__link" href="{{ . }}">inicio</a>.
button_toggle_dark: Cambiar el modo Oscuro/Claro/Auto
button_nav_open: Abrir la Navegación
button_nav_close: Cerrar la Navegación
button_menu_open: Abrir el Menú Bar
button_menu_close: Cerrar el Menú Bar
button_homepage: Volver al Inicio
title_anchor_prefix: "Anclado a:"
posts_read_more: Lee la publicación completa
posts_read_time:
one: "Un minuto para leer"
other: "{{ . }} minutos para leer"
posts_update_prefix: Actualizado en
posts_count:
one: "Una publicación"
other: "{{ . }} publicaciones"
posts_tagged_with: Todas las publicaciones etiquetadas con '{{ . }}'
footer_build_with: >
Creado con <a href="https://gohugo.io/" class="gdoc-footer__link">Hugo</a> y
<svg class="gdoc-icon gdoc_heart"><use xlink:href="#gdoc_heart"></use></svg>
footer_legal_notice: Aviso Legal
footer_privacy_policy: Política de Privacidad
footer_content_license_prefix: >
Contenido licenciado con
language_switch_no_tranlation_prefix: "Página no traducida:"
propertylist_required: requerido
propertylist_optional: opcional
propertylist_default: estándar
pagination_page_prev: previo
pagination_page_next: siguiente
pagination_page_state: "{{ .PageNumber }}/{{ .TotalPages }}"

View file

@ -1,4 +1,4 @@
{{- $showAnchor := (and (default true .Page.Params.GeekdocAnchor) (default true .Page.Site.Params.GeekdocAnchor)) -}}
{{- $showAnchor := (and (default true .Page.Params.geekdocAnchor) (default true .Page.Site.Params.geekdocAnchor)) -}}
<!-- prettier-ignore-start -->

View file

@ -2,7 +2,7 @@
<html
lang="{{ .Site.Language.Lang }}"
class="color-toggle-hidden"
{{ if default false .Site.Params.GeekdocDarkModeCode }}code-theme="dark"{{ end }}
{{ if default false .Site.Params.geekdocDarkModeCode }}code-theme="dark"{{ end }}
>
<head>
{{ partial "head/meta" . }}
@ -33,7 +33,7 @@
>
<input type="checkbox" class="hidden" id="menu-control" />
<input type="checkbox" class="hidden" id="menu-header-control" />
{{ $navEnabled := default true .Page.Params.GeekdocNav }}
{{ $navEnabled := default true .Page.Params.geekdocNav }}
{{ partial "site-header" (dict "Root" . "MenuEnabled" $navEnabled) }}

View file

@ -3,7 +3,7 @@
<article
class="gdoc-markdown gdoc-markdown__align--{{ default "left" (.Page.Params.GeekdocAlign | lower) }}"
class="gdoc-markdown gdoc-markdown__align--{{ default "left" (.Page.Params.geekdocAlign | lower) }}"
>
<h1>{{ partial "utils/title" . }}</h1>
{{ partial "utils/content" . }}

View file

@ -3,7 +3,7 @@
<article
class="gdoc-markdown gdoc-markdown__align--{{ default "left" (.Page.Params.GeekdocAlign | lower) }}"
class="gdoc-markdown gdoc-markdown__align--{{ default "left" (.Page.Params.geekdocAlign | lower) }}"
>
<h1>{{ partial "utils/title" . }}</h1>
{{ partial "utils/content" . }}

View file

@ -1,4 +1,4 @@
{{ if default true .Site.Params.GeekdocSearch }}
{{ if default true .Site.Params.geekdocSearch }}
<script defer src="{{ index (index .Site.Data.assets "search.js") "src" | relURL }}"></script>
{{- $searchConfigFile := printf "search/%s.config.json" .Language.Lang -}}
{{- $searchConfig := resources.Get "search/config.json" | resources.ExecuteAsTemplate $searchConfigFile . | resources.Minify -}}

View file

@ -1,4 +1,4 @@
{{- if default true .Site.Params.GeekdocDarkModeToggle }}
{{- if default true .Site.Params.geekdocDarkModeToggle }}
<script src="{{ index (index .Site.Data.assets "colortheme.js") "src" | relURL }}"></script>
{{- end }}
<script src="{{ index (index .Site.Data.assets "main.js") "src" | relURL }}"></script>
@ -66,7 +66,7 @@
{{ printf `<link href=%q rel=%q type=%q />` .Permalink .Rel .MediaType.Type | safeHTML }}
{{- end }}
{{- if (default false $.Site.Params.GeekdocOverwriteHTMLBase) }}
{{- if (default false $.Site.Params.geekdocOverwriteHTMLBase) }}
<base href="{{ .Site.BaseURL }}" />
{{- end }}

View file

@ -25,7 +25,7 @@
{{ $isCurrent := eq $current $this }}
{{ $isAncestor := $this.IsAncestor $current }}
{{ $id := substr (sha1 $this.Permalink) 0 8 }}
{{ $doCollapse := and (isset . "sub") (or $this.Params.GeekdocCollapseSection (default false .Site.Params.GeekdocCollapseAllSections)) }}
{{ $doCollapse := and (isset . "sub") (or $this.Params.geekdocCollapseSection (default false .Site.Params.geekdocCollapseAllSections)) }}
{{ $anchor := default "" .anchor }}
{{ if $anchor }}

View file

@ -8,7 +8,7 @@
<ul class="gdoc-nav__list">
{{ $sortBy := (default "title" .current.Site.Params.GeekdocFileTreeSortBy | lower) }}
{{ $sortBy := (default "title" .current.Site.Params.geekdocFileTreeSortBy | lower) }}
{{ range .sect.GroupBy "Weight" }}
{{ $rangeBy := .ByTitle }}
@ -39,13 +39,13 @@
{{ end }}
{{ range $rangeBy }}
{{ if not .Params.GeekdocHidden }}
{{ if not .Params.geekdocHidden }}
{{ $numberOfPages := (add (len .Pages) (len .Sections)) }}
{{ $isParent := and (ne $numberOfPages 0) (not .Params.GeekdocFlatSection) }}
{{ $isParent := and (ne $numberOfPages 0) (not .Params.geekdocFlatSection) }}
{{ $isCurrent := eq $current . }}
{{ $isAncestor := .IsAncestor $current }}
{{ $id := substr (sha1 .Permalink) 0 8 }}
{{ $doCollapse := and $isParent (or .Params.GeekdocCollapseSection (default false .Site.Params.GeekdocCollapseAllSections)) }}
{{ $doCollapse := and $isParent (or .Params.geekdocCollapseSection (default false .Site.Params.geekdocCollapseAllSections)) }}
<li>
@ -63,7 +63,7 @@
for="{{ printf "navtree-%s" $id }}" class="flex justify-between align-center"
{{ end }}
>
{{ if or .Content .Params.GeekdocFlatSection }}
{{ if or .Content .Params.geekdocFlatSection }}
<span class="flex">
<a
href="{{ .RelPermalink }}"

View file

@ -49,7 +49,7 @@
{{ end }}
{{ end }}
{{ $showPrevNext := (and (default true .Site.Params.GeekdocNextPrev) .Site.Params.GeekdocMenuBundle) }}
{{ $showPrevNext := (and (default true .Site.Params.geekdocNextPrev) .Site.Params.geekdocMenuBundle) }}
{{ if $showPrevNext }}
<span class="gdoc-page__nav">
{{ with ($current.Scratch.Get "prevPage") }}

View file

@ -10,7 +10,7 @@
{{ end }}
</section>
{{ if and (in (slice "posts" "tags") .Section) (default false .Site.Params.GeekdocTagsToMenu) }}
{{ if and (in (slice "posts" "tags") .Section) (default false .Site.Params.geekdocTagsToMenu) }}
<section class="gdoc-nav--tags">
<h2>{{ i18n "nav_tags" }}</h2>
<ul class="gdoc-nav__list">

View file

@ -12,7 +12,7 @@
{{- with partial "utils/featured" . }}
"thumbnailUrl": {{ . }},
{{- end }}
{{- with .Site.Params.GeekdocContentLicense }}
{{- with .Site.Params.geekdocContentLicense }}
"license": "{{ .name }}",
{{- end }}
"inLanguage": {{ .Lang }}
@ -37,7 +37,7 @@
"thumbnailUrl": {{ . }},
{{- end }}
"wordCount" : "{{ .WordCount }}",
{{- with .Site.Params.GeekdocContentLicense }}
{{- with .Site.Params.geekdocContentLicense }}
"license": "{{ .name }}",
{{- end }}
"inLanguage": {{ .Lang }},

View file

@ -1,7 +1,7 @@
{{ $geekdocRepo := default (default false .Site.Params.GeekdocRepo) .Page.Params.GeekdocRepo }}
{{ $geekdocEditPath := default (default false .Site.Params.GeekdocEditPath) .Page.Params.GeekdocEditPath }}
{{ $geekdocRepo := default (default false .Site.Params.geekdocRepo) .Page.Params.geekdocRepo }}
{{ $geekdocEditPath := default (default false .Site.Params.geekdocEditPath) .Page.Params.geekdocEditPath }}
{{ if .File }}
{{ $.Scratch.Set "geekdocFilePath" (default (path.Join (default "content" .Site.Params.contentDir) .File.Path) .Page.Params.GeekdocFilePath) }}
{{ $.Scratch.Set "geekdocFilePath" (default (strings.TrimPrefix hugo.WorkingDir .File.Filename) .Page.Params.geekdocFilePath) }}
{{ else }}
{{ $.Scratch.Set "geekdocFilePath" false }}
{{ end }}
@ -18,7 +18,7 @@
{{ end }}
{{ end }}
{{ $showBreadcrumb := (and (default true .Page.Params.GeekdocBreadcrumb) (default true .Site.Params.GeekdocBreadcrumb)) }}
{{ $showBreadcrumb := (and (default true .Page.Params.geekdocBreadcrumb) (default true .Site.Params.geekdocBreadcrumb)) }}
{{ $showEdit := (and ($.Scratch.Get "geekdocFilePath") $geekdocRepo $geekdocEditPath) }}
<div
class="gdoc-page__header flex flex-wrap

View file

@ -1,4 +1,4 @@
{{ if default true .Site.Params.GeekdocSearch }}
{{ if default true .Site.Params.geekdocSearch }}
<div class="gdoc-search flex align-center">
<svg class="gdoc-icon gdoc_search"><use xlink:href="#gdoc_search"></use></svg>
<input

View file

@ -9,7 +9,7 @@
</a>
</span>
{{ end }}
{{ with .Site.Params.GeekdocPrivacyPolicy }}
{{ with .Site.Params.geekdocPrivacyPolicy }}
<span class="gdoc-footer__item gdoc-footer__item--row">
<a href="{{ . | relURL }}" class="gdoc-footer__link">
{{ i18n "footer_privacy_policy" }}
@ -17,7 +17,7 @@
</span>
{{ end }}
</section>
{{ with .Site.Params.GeekdocContentLicense }}
{{ with .Site.Params.geekdocContentLicense }}
<section class="flex flex-wrap align-center">
<span class="gdoc-footer__item">
{{ i18n "footer_content_license_prefix" }}
@ -26,7 +26,7 @@
</section>
{{ end }}
</div>
{{ if (default true .Site.Params.GeekdocBackToTop) }}
{{ if (default true .Site.Params.geekdocBackToTop) }}
<div class="flex flex-25 justify-end">
<span class="gdoc-footer__item text-right">
<a class="gdoc-footer__link fake-link" href="#" aria-label="{{ i18n "nav_top" }}">

View file

@ -17,7 +17,7 @@
<span class="flex align-center">
<img
class="gdoc-brand__img"
src="{{ (default "brand.svg" .Root.Site.Params.GeekdocLogo) | relURL }}"
src="{{ (default "brand.svg" .Root.Site.Params.geekdocLogo) | relURL }}"
alt=""
/>
<span class="gdoc-brand__title">{{ .Root.Site.Title }}</span>

View file

@ -6,6 +6,6 @@
</label>
<input id="{{ $id }}-{{ .Ordinal }}" type="checkbox" class="gdoc-expand__control hidden" />
<div class="gdoc-markdown--nested gdoc-expand__content">
{{ .Inner | $.Page.RenderString | htmlUnescape | safeHTML }}
{{ .Inner | $.Page.RenderString }}
</div>
</div>

View file

@ -1,7 +1,7 @@
{{- $source := ($.Page.Resources.ByType "image").GetMatch (printf "%s" (.Get "name")) }}
{{- $customAlt := .Get "alt" }}
{{- $customSize := .Get "size" | lower }}
{{- $lazyLoad := default (default true $.Site.Params.GeekdocImageLazyLoading) (.Get "lazy") }}
{{- $lazyLoad := default (default true $.Site.Params.geekdocImageLazyLoading) (.Get "lazy") }}
{{- $data := newScratch }}
{{- with $source }}

View file

@ -1,4 +1,4 @@
{{- $tocLevels := default (default 6 .Site.Params.GeekdocToC) .Page.Params.GeekdocToC }}
{{- $tocLevels := default (default 6 .Site.Params.geekdocToC) .Page.Params.geekdocToC }}
{{- if $tocLevels }}
<div class="gdoc-toc gdoc-toc__level--{{ $tocLevels }}">
@ -12,23 +12,25 @@
<ul>
{{- range .sect.GroupBy "Weight" }}
{{- range .ByTitle }}
{{- if or (not .Params.GeekdocHidden) (not (default true .Params.GeekdocHiddenTocTree)) }}
{{- if or (not .Params.geekdocHidden) (not (default true .Params.geekdocHiddenTocTree)) }}
<li>
{{- if or .Content .Params.GeekdocFlatSection }}
{{- if or .Content .Params.geekdocFlatSection }}
<span>
<a href="{{ .RelPermalink }}" class="gdoc-toc__entry">
{{- partial "utils/title" . }}{{ with .Params.GeekdocDescription }}:{{ end }}
{{- partial "utils/title" . }}{{ with .Params.geekdocDescription }}:{{ end }}
</a>
{{- with .Params.GeekdocDescription }}{{ . }}{{ end }}
{{- with .Params.geekdocDescription }}{{ . }}{{ end }}
</span>
{{- else -}}
<span>
{{- partial "utils/title" . }}{{ with .Params.GeekdocDescription }}: {{ . }}{{ end }}
{{- partial "utils/title" . }}{{ with .Params.geekdocDescription }}
: {{ . }}
{{ end }}
</span>
{{- end -}}
{{- $numberOfPages := (add (len .Pages) (len .Sections)) }}
{{- if and (ne $numberOfPages 0) (not .Params.GeekdocFlatSection) }}
{{- if and (ne $numberOfPages 0) (not .Params.geekdocFlatSection) }}
{{- template "toc-tree" dict "sect" .Pages }}
{{- end }}
</li>

View file

@ -1,5 +1,5 @@
{{- $format := default "html" (.Get "format") }}
{{- $tocLevels := default (default 6 .Site.Params.GeekdocToC) .Page.Params.GeekdocToC }}
{{- $tocLevels := default (default 6 .Site.Params.geekdocToC) .Page.Params.geekdocToC }}
{{- if and $tocLevels .Page.TableOfContents -}}
{{- if not (eq ($format | lower) "raw") -}}

3579
package-lock.json generated

File diff suppressed because it is too large Load diff

View file

@ -16,7 +16,7 @@
"svg:sprite": "svg-sprite -C svgsprite.config.json 'src/icons/*.svg'",
"svg:font": "svgtofont --sources build/icons/ --output build/fonts/",
"prep:clean": "shx rm -rf build/ static/",
"prep:clean-all": "shx rm -rf build/ dist/ static/ data/ assets/sprites/ exampleSite/data/sprites/",
"prep:clean-all": "shx rm -rf VERSION .lighthouseci/ lhci_reports/ build/ dist/ static/ data/ assets/sprites/ exampleSite/data/sprites/ exampleSite/public/ exampleSite/resources/ exampleSite/.hugo_build.lock",
"prep:make": "shx mkdir -p build/icons/ build/fonts/ dist/",
"svg-sprite-list": "run-s prep:make svg ; shx mkdir -p exampleSite/data/sprites/ ; shx cp build/fonts/GeekdocIcons.json exampleSite/data/sprites/geekdoc.json",
"lint": "eslint src/js/ --color"
@ -34,32 +34,31 @@
"@cfworker/json-schema": "1.12.5",
"clipboard": "2.0.11",
"flexsearch": "0.7.31",
"katex": "0.16.6",
"katex": "0.16.8",
"lodash": "4.17.21",
"mermaid": "10.1.0",
"mermaid": "10.2.4",
"store2": "2.14.2"
},
"devDependencies": {
"@babel/eslint-parser": "7.21.3",
"@babel/eslint-parser": "7.22.7",
"@eloquent/git-version-webpack-plugin": "5.0.1",
"autoprefixer": "10.4.14",
"copy-webpack-plugin": "11.0.0",
"css-loader": "6.7.3",
"eslint": "8.39.0",
"css-loader": "6.8.1",
"eslint": "8.44.0",
"eslint-config-prettier": "8.8.0",
"eslint-plugin-prettier": "4.2.1",
"favicons": "7.1.2",
"eslint-plugin-prettier": "5.0.0",
"favicons": "7.1.3",
"npm-run-all": "4.1.5",
"postcss-loader": "7.2.4",
"prettier": "2.8.8",
"prettier-plugin-go-template": "0.0.13",
"sass": "1.62.0",
"sass-loader": "13.2.2",
"postcss-loader": "7.3.3",
"prettier": "3.0.0",
"sass": "1.63.6",
"sass-loader": "13.3.2",
"shx": "0.3.4",
"svg-sprite": "2.0.2",
"svgtofont": "3.23.1",
"webpack": "5.80.0",
"webpack-cli": "5.0.2",
"svgtofont": "3.25.4",
"webpack": "5.88.1",
"webpack-cli": "5.1.4",
"webpack-favicons": "1.3.8",
"webpack-manifest-plugin": "5.0.0",
"webpack-remove-empty-scripts": "1.0.3"

View file

@ -3,9 +3,9 @@
<svg
fill="#000000"
width="695"
height="695"
viewBox="0 0 20.85 20.85"
width="640"
height="640"
viewBox="0 0 19.2 19.2"
id="agenda-pencil"
data-name="Line Color"
class="icon line-color"
@ -28,30 +28,59 @@
inkscape:pagecheckerboard="0"
inkscape:deskcolor="#d1d1d1"
showgrid="false"
inkscape:zoom="0.3958404"
inkscape:cx="437.04483"
inkscape:cy="915.77312"
inkscape:zoom="0.31457183"
inkscape:cx="208.21953"
inkscape:cy="580.15366"
inkscape:window-width="2560"
inkscape:window-height="1371"
inkscape:window-x="0"
inkscape:window-y="32"
inkscape:window-maximized="1"
inkscape:current-layer="agenda-pencil" />
inkscape:current-layer="g1488" />
<g
id="g157"
transform="translate(0.06082949)">
<path
id="secondary"
d="M 19.08741,5.6462257 17.258775,3.8175911 a 1.3061676,1.3061676 0 0 0 -1.828634,0 L 9.016858,10.230874 v 3.657269 h 3.657269 L 19.08741,7.4748603 a 1.3061676,1.3061676 0 0 0 0,-1.8286346 z"
style="fill:none;stroke:#f66b0e;stroke-width:2.55;stroke-linecap:round;stroke-linejoin:round;stroke-dasharray:none;stroke-opacity:1" />
<path
id="primary"
d="m 15.566162,16.453545 v 2.009515 a 0.93635558,1.0047573 0 0 1 -0.936355,1.004757 H 3.3935396 A 0.93635558,1.0047573 0 0 1 2.457184,18.46306 V 2.3869423 A 0.93635558,1.0047573 0 0 1 3.3935396,1.382185 h 9.3635554"
style="fill:none;stroke:#efefef;stroke-width:2.76437;stroke-linecap:round;stroke-linejoin:round;stroke-dasharray:none;stroke-opacity:1" />
<path
id="primary-2"
data-name="primary"
d="m 1.5,6.425001 h 2 m -2,4 h 2 m -2,4 h 2"
style="fill:none;stroke:#efefef;stroke-width:3;stroke-linecap:round;stroke-linejoin:round;stroke-dasharray:none;stroke-opacity:1" />
transform="translate(-1.1826015,-0.83436748)">
<g
id="g724"
transform="translate(0.51504447)">
<g
id="g729">
<g
id="g734"
transform="translate(0.02223447,0.00163038)">
<g
id="g739"
transform="translate(0.074562)">
<g
id="g783"
transform="translate(0.31786391,0.00163038)">
<g
id="g1345"
transform="translate(-0.03687642,0.00611342)">
<g
id="g1488">
<g
id="g1507">
<path
id="secondary"
d="M 18.244015,6.33001 16.574991,4.6609857 a 1.1921603,1.1921603 0 0 0 -1.669024,0 L 9.05246,10.514493 v 3.338048 h 3.338049 l 5.853506,-5.8535067 a 1.1921603,1.1921603 0 0 0 0,-1.6690243 z"
style="fill:none;stroke:#f66b0e;stroke-width:1.8;stroke-linecap:round;stroke-linejoin:round;stroke-dasharray:none;stroke-opacity:1" />
<path
id="primary"
d="m 14.897123,16.029614 v 1.868208 a 0.88539335,0.93410346 0 0 1 -0.885392,0.934103 H 3.3870098 A 0.88539335,0.93410346 0 0 1 2.5016166,17.897822 V 2.952165 A 0.88539335,0.93410346 0 0 1 3.3870098,2.0180616 h 8.8539322"
style="fill:none;stroke:#efefef;stroke-width:2.37391;stroke-linecap:round;stroke-linejoin:round;stroke-dasharray:none;stroke-opacity:1" />
<path
id="primary-2"
data-name="primary"
d="m 1.5,6.4249937 h 2 m -2,3.9999993 h 2 m -2,4 h 2"
style="fill:none;stroke:#efefef;stroke-width:2.4;stroke-linecap:round;stroke-linejoin:round;stroke-dasharray:none;stroke-opacity:1" />
</g>
</g>
</g>
</g>
</g>
</g>
</g>
</g>
</g>
</svg>

Before

Width:  |  Height:  |  Size: 2.3 KiB

After

Width:  |  Height:  |  Size: 3.2 KiB

View file

@ -3,9 +3,9 @@
<svg
fill="#000000"
width="695"
height="695.00006"
viewBox="0 0 20.85 20.850002"
width="640"
height="640"
viewBox="0 0 19.2 19.2"
id="agenda-pencil"
data-name="Line Color"
class="icon line-color"
@ -28,30 +28,56 @@
inkscape:pagecheckerboard="0"
inkscape:deskcolor="#d1d1d1"
showgrid="false"
inkscape:zoom="0.3958404"
inkscape:cx="437.04483"
inkscape:cy="915.77312"
inkscape:zoom="0.31457183"
inkscape:cx="208.21953"
inkscape:cy="580.15366"
inkscape:window-width="2560"
inkscape:window-height="1371"
inkscape:window-x="0"
inkscape:window-y="32"
inkscape:window-maximized="1"
inkscape:current-layer="agenda-pencil" />
inkscape:current-layer="g1345" />
<g
id="g157"
transform="translate(0.06082953)">
<path
id="secondary"
d="M 19.08741,5.6462257 17.258775,3.8175911 a 1.3061676,1.3061676 0 0 0 -1.828634,0 L 9.016858,10.230874 v 3.657269 h 3.657269 L 19.08741,7.4748603 a 1.3061676,1.3061676 0 0 0 0,-1.8286346 z"
style="fill:none;stroke:#f66b0e;stroke-width:2.55;stroke-linecap:round;stroke-linejoin:round;stroke-dasharray:none;stroke-opacity:1" />
<path
id="primary"
d="m 15.566162,16.453545 v 2.009515 a 0.93635558,1.0047573 0 0 1 -0.936355,1.004757 H 3.3935396 A 0.93635558,1.0047573 0 0 1 2.457184,18.46306 V 2.3869423 A 0.93635558,1.0047573 0 0 1 3.3935396,1.382185 h 9.3635554"
style="fill:none;stroke:#112b3c;stroke-width:2.76437;stroke-linecap:round;stroke-linejoin:round;stroke-dasharray:none;stroke-opacity:1" />
<path
id="primary-2"
data-name="primary"
d="m 1.5,6.425001 h 2 m -2,4 h 2 m -2,4 h 2"
style="fill:none;stroke:#112b3c;stroke-width:3;stroke-linecap:round;stroke-linejoin:round;stroke-dasharray:none;stroke-opacity:1" />
transform="translate(-1.1826015,-0.83436748)">
<g
id="g724"
transform="translate(0.51504447)">
<g
id="g729">
<g
id="g734"
transform="translate(0.02223447,0.00163038)">
<g
id="g739"
transform="translate(0.074562)">
<g
id="g783"
transform="translate(0.31786391,0.00163038)">
<g
id="g1345"
transform="translate(-0.03687642,0.00611342)">
<g
id="g1488">
<path
id="secondary"
d="M 18.244015,6.33001 16.574991,4.6609857 a 1.1921603,1.1921603 0 0 0 -1.669024,0 L 9.05246,10.514493 v 3.338048 h 3.338049 l 5.853506,-5.8535067 a 1.1921603,1.1921603 0 0 0 0,-1.6690243 z"
style="fill:none;stroke:#f66b0e;stroke-width:1.8;stroke-linecap:round;stroke-linejoin:round;stroke-dasharray:none;stroke-opacity:1" />
<path
id="primary"
d="m 14.897123,16.029614 v 1.868208 a 0.88539335,0.93410346 0 0 1 -0.885392,0.934103 H 3.3870098 A 0.88539335,0.93410346 0 0 1 2.5016166,17.897822 V 2.952165 A 0.88539335,0.93410346 0 0 1 3.3870098,2.0180616 h 8.8539322"
style="fill:none;stroke:#112b3c;stroke-width:2.37391;stroke-linecap:round;stroke-linejoin:round;stroke-dasharray:none;stroke-opacity:1" />
<path
id="primary-2"
data-name="primary"
d="m 1.5,6.4249937 h 2 m -2,3.9999993 h 2 m -2,4 h 2"
style="fill:none;stroke:#112b3c;stroke-width:2.4;stroke-linecap:round;stroke-linejoin:round;stroke-dasharray:none;stroke-opacity:1" />
</g>
</g>
</g>
</g>
</g>
</g>
</g>
</g>
</svg>

Before

Width:  |  Height:  |  Size: 2.3 KiB

After

Width:  |  Height:  |  Size: 3.1 KiB

View file

@ -5,7 +5,7 @@ description = "Hugo theme made for documentation"
homepage = "https://geekdocs.de/"
demosite = "https://geekdocs.de/"
tags = ["docs", "documentation", "responsive", "simple"]
min_version = "0.93.0"
min_version = "0.112.0"
[author]
name = "Robert Kaussow"