Skip to content

Commit 4b0f539

Browse files
committed
Update main to output generated at 66da676
0 parents  commit 4b0f539

File tree

269 files changed

+4090
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

269 files changed

+4090
-0
lines changed

.nvmrc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
lts/*

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2022 Robert Kaussow <[email protected]>
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is furnished
10+
to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice (including the next
13+
paragraph) shall be included in all copies or substantial portions of the
14+
Software.
15+
16+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
18+
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS
19+
OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
20+
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF
21+
OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

Lines changed: 122 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,122 @@
1+
# CYBERTEC Geekdoc
2+
3+
A CYBERTEC themed fork of [geekdoc](https://github.com/thegeeklab/hugo-geekdoc), a Hugo theme made for documentation.
4+
5+
---
6+
7+
## Requirements
8+
9+
- [`go`](https://go.dev/doc/install)
10+
- [`hugo`](https://gohugo.io/installation/)
11+
12+
## Usage
13+
14+
Initialize a new hugo site:
15+
16+
```shell
17+
hugo new site <site-name>
18+
cd <site-name>
19+
```
20+
21+
Initialize the site as a go module:
22+
23+
```shell
24+
hugo mod init github.com/cybertec-postgresql/<repository-name>
25+
```
26+
27+
Add the following to your `hugo.toml` to use this theme, including functional code-highlighting:
28+
29+
```toml
30+
# hugo.toml
31+
pygmentsCodeFences = true
32+
pygmentsUseClasses = true
33+
34+
[module]
35+
[[module.imports]]
36+
path = 'github.com/cybertec-postgresql/hugo-geekdoc'
37+
```
38+
39+
Fetch the module
40+
41+
```shell
42+
hugo mod get -u
43+
```
44+
45+
Build your page
46+
```shell
47+
hugo --minify
48+
# You may optionally overwrite the `baseURL`
49+
hugo --minify -b "/docs/"
50+
```
51+
52+
## Update
53+
54+
To retrieve the latest version of this theme, simply run
55+
56+
```shell
57+
hugo mod get -u
58+
hugo mod tidy
59+
```
60+
61+
## Development
62+
63+
The fork and source code is located inside the `dev` branch. On push, a GitHub Actions workflow will build and push the release to the `main` branch.
64+
65+
### Sync fork
66+
67+
```
68+
git checkout dev
69+
git rebase upstream/main
70+
git push --force
71+
```
72+
73+
---
74+
75+
The contents below are from the original Geekdoc README.
76+
77+
---
78+
79+
[![Build Status](https://ci.thegeeklab.de/api/badges/thegeeklab/hugo-geekdoc/status.svg)](https://ci.thegeeklab.de/repos/thegeeklab/hugo-geekdoc)
80+
[![Hugo Version](https://img.shields.io/badge/hugo-0.124-blue.svg)](https://gohugo.io)
81+
[![GitHub release](https://img.shields.io/github/v/release/thegeeklab/hugo-geekdoc)](https://github.com/thegeeklab/hugo-geekdoc/releases/latest)
82+
[![GitHub contributors](https://img.shields.io/github/contributors/thegeeklab/hugo-geekdoc)](https://github.com/thegeeklab/hugo-geekdoc/graphs/contributors)
83+
[![License: MIT](https://img.shields.io/github/license/thegeeklab/hugo-geekdoc)](https://github.com/thegeeklab/hugo-geekdoc/blob/main/LICENSE)
84+
85+
Geekdoc is a simple Hugo theme for documentations. It is intentionally designed as a fast and lean theme and may not fit the requirements of complex projects. If a more feature-complete theme is required there are a lot of good alternatives out there. You can find a demo and the full documentation at [https://geekdocs.de](https://geekdocs.de).
86+
87+
![Desktop and mobile preview](https://raw.githubusercontent.com/thegeeklab/hugo-geekdoc/main/images/readme.png)
88+
89+
## Build and release process
90+
91+
This theme is subject to a CI driven build and release process common for software development. During the release build, all necessary assets are automatically built by [webpack](https://webpack.js.org/) and bundled in a release tarball. You can download the latest release from the GitHub [release page](https://github.com/thegeeklab/hugo-geekdoc/releases).
92+
93+
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.
94+
95+
```shell
96+
# install required packages from package.json
97+
npm install
98+
99+
# run the build script to build required assets
100+
npm run build
101+
102+
# build release tarball
103+
npm run pack
104+
```
105+
106+
See the [Getting Started Guide](https://geekdocs.de/usage/getting-started/) for details about the different setup options.
107+
108+
## Contributors
109+
110+
Special thanks to all [contributors](https://github.com/thegeeklab/hugo-geekdoc/graphs/contributors). If you would like to contribute, please see the [instructions](https://github.com/thegeeklab/hugo-geekdoc/blob/main/CONTRIBUTING.md).
111+
112+
Geekdoc is inspired and partially based on the [hugo-book](https://github.com/alex-shpak/hugo-book) theme, thanks [Alex Shpak](https://github.com/alex-shpak/) for your work.
113+
114+
## License
115+
116+
This project is licensed under the MIT License - see the [LICENSE](https://github.com/thegeeklab/hugo-geekdoc/blob/main/LICENSE) file for details.
117+
118+
The used SVG icons and generated icon fonts are licensed under the license of the respective icon pack:
119+
120+
- Font Awesome: [CC BY 4.0 License](https://github.com/FortAwesome/Font-Awesome#license)
121+
- IcoMoon Free Pack: [GPL/CC BY 4.0](https://icomoon.io/#icons-icomoon)
122+
- Material Icons: [Apache License 2.0](https://github.com/google/material-design-icons/blob/main/LICENSE)

VERSION

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
dev@66da676

archetypes/docs.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: "{{ .Name | humanize | title }}"
3+
weight: 1
4+
# geekdocFlatSection: false
5+
# geekdocToc: 6
6+
# geekdocHidden: false
7+
---

archetypes/posts.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
---
2+
title: "{{ replace .Name "-" " " | title }}"
3+
date: {{ .Date }}
4+
---

assets/search/config.json

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{{- $searchDataFile := printf "search/%s.data.json" .Language.Lang -}}
2+
{{- $searchData := resources.Get "search/data.json" | resources.ExecuteAsTemplate $searchDataFile . | resources.Minify -}}
3+
{
4+
"dataFile": {{ $searchData.RelPermalink | jsonify }},
5+
"indexConfig": {{ .Site.Params.geekdocSearchConfig | jsonify }},
6+
"showParent": {{ if .Site.Params.geekdocSearchShowParent }}true{{ else }}false{{ end }},
7+
"showDescription": {{ if .Site.Params.geekdocSearchshowDescription }}true{{ else }}false{{ end }}
8+
}

assets/search/data.json

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
[
2+
{{ range $index, $page := (where .Site.Pages "Params.geekdocProtected" "ne" true) }}
3+
{{ if ne $index 0 }},{{ end }}
4+
{
5+
"id": {{ $index }},
6+
"href": "{{ $page.RelPermalink }}",
7+
"title": {{ (partial "utils/title" $page) | jsonify }},
8+
"parent": {{ with $page.Parent }}{{ (partial "utils/title" .) | jsonify }}{{ else }}""{{ end }},
9+
"content": {{ $page.Plain | jsonify }},
10+
"description": {{ $page.Summary | plainify | jsonify }}
11+
}
12+
{{ end }}
13+
]

assets/sprites/cpo.svg

Lines changed: 44 additions & 0 deletions
Loading

assets/sprites/cybertec.svg

Lines changed: 67 additions & 0 deletions
Loading

0 commit comments

Comments
 (0)