migrate to thegeeklab namespace

This commit is contained in:
Robert Kaussow 2020-09-27 22:21:29 +02:00
parent 257253a1bd
commit f8d2670528
No known key found for this signature in database
GPG key ID: 65362AE74AF98B61
12 changed files with 32 additions and 32 deletions

View file

@ -24,19 +24,19 @@ steps:
- hugo-official -s exampleSite/ -b http://localhost/ - hugo-official -s exampleSite/ -b http://localhost/
- name: html-validation - name: html-validation
image: xoxys/vnu image: thegeeklab/vnu
commands: commands:
- vnu --skip-non-html --also-check-css --errors-only exampleSite/public - vnu --skip-non-html --also-check-css --errors-only exampleSite/public
- name: link-validation - name: link-validation
image: xoxys/link-validator image: thegeeklab/link-validator
commands: commands:
- link-validator -ro - link-validator -ro
environment: environment:
LINK_VALIDATOR_BASE_DIR: exampleSite/public LINK_VALIDATOR_BASE_DIR: exampleSite/public
- name: page-validation - name: page-validation
image: xoxys/lhci image: thegeeklab/lhci
commands: commands:
- lhci autorun - lhci autorun
environment: environment:
@ -150,7 +150,7 @@ steps:
image: byrnedo/alpine-curl image: byrnedo/alpine-curl
commands: commands:
- mkdir -p exampleSite/themes/hugo-geekdoc/ - mkdir -p exampleSite/themes/hugo-geekdoc/
- curl -sSL https://github.com/xoxys/hugo-geekdoc/releases/latest/download/hugo-geekdoc.tar.gz | tar -xz -C exampleSite/themes/hugo-geekdoc/ --strip-components=1 - 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
- name: build - name: build
image: klakegg/hugo:0.74.3-ext-alpine image: klakegg/hugo:0.74.3-ext-alpine
@ -234,6 +234,6 @@ depends_on:
--- ---
kind: signature kind: signature
hmac: 082cef9076e41be30895bc3500bb2ebf888ae24e978e41cea71cd2e45c80b483 hmac: 548bc9f137bf276ff6415afcf396600cebe4a689e97bd8e0687e3921ee7aad63
... ...

View file

@ -1,18 +1,18 @@
# Geekdoc # Geekdoc
[![Build Status](https://img.shields.io/drone/build/xoxys/hugo-geekdoc?logo=drone)](https://cloud.drone.io/xoxys/hugo-geekdoc) [![Build Status](https://img.shields.io/drone/build/thegeeklab/hugo-geekdoc?logo=drone)](https://cloud.drone.io/thegeeklab/hugo-geekdoc)
[![Hugo Version](https://img.shields.io/badge/hugo-0.65-blue.svg)](https://gohugo.io) [![Hugo Version](https://img.shields.io/badge/hugo-0.65-blue.svg)](https://gohugo.io)
[![GitHub release](https://img.shields.io/github/v/release/xoxys/hugo-geekdoc)](https://github.com/xoxys/hugo-geekdoc/releases/latest) [![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/xoxys/hugo-geekdoc)](https://github.com/xoxys/hugo-geekdoc/graphs/contributors) [![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/xoxys/hugo-geekdoc)](https://github.com/xoxys/hugo-geekdoc/blob/master/LICENSE) [![License: MIT](https://img.shields.io/github/license/thegeeklab/hugo-geekdoc)](https://github.com/thegeeklab/hugo-geekdoc/blob/master/LICENSE)
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 got alternatives out there. You can find a demo and the full documentation at [https://geekdocs.de](https://geekdocs.de). 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 got alternatives out there. You can find a demo and the full documentation at [https://geekdocs.de](https://geekdocs.de).
![Desktop and mobile preview](https://github.com/xoxys/hugo-geekdoc/blob/master/images/readme.png) ![Desktop and mobile preview](https://github.com/thegeeklab/hugo-geekdoc/blob/master/images/readme.png)
## Build and release process ## Build and release process
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 [gulp](https://gulpjs.com/) and bundled in a release tarball. You can download the latest release from the GitHub [release page](https://github.com/xoxys/hugo-geekdoc/releases). 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 [gulp](https://gulpjs.com/) and bundled in a release tarball. You can download the latest release from the GitHub [release page](https://github.com/thegeeklab/hugo-geekdoc/releases).
Due to the fact that `gulp` is used as pre-processor the theme cannot be used from the master branch by default. If you want to use the theme from a cloned branch instead of a release tarball you'll need to install `gulp` locally and run the default pipeline once to create all required assets. Due to the fact that `gulp` is used as pre-processor the theme cannot be used from the master branch by default. If you want to use the theme from a cloned branch instead of a release tarball you'll need to install `gulp` locally and run the default pipeline once to create all required assets.
@ -28,10 +28,10 @@ See the [Getting Started Guide](https://geekdocs.de/usage/getting_started/) for
## Contributors ## Contributors
Special thanks goes to all [contributors](https://github.com/xoxys/hugo-geekdoc/graphs/contributors). Special thanks goes to all [contributors](https://github.com/thegeeklab/hugo-geekdoc/graphs/contributors).
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. 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.
## License ## License
This project is licensed under the MIT License - see the [LICENSE](https://github.com/xoxys/hugo-geekdoc/blob/master/LICENSE) file for details. This project is licensed under the MIT License - see the [LICENSE](https://github.com/thegeeklab/hugo-geekdoc/blob/master/LICENSE) file for details.

View file

@ -21,7 +21,7 @@ markup:
params: params:
geekdocToC: 3 geekdocToC: 3
geekdocRepo: https://github.com/xoxys/hugo-geekdoc geekdocRepo: https://github.com/thegeeklab/hugo-geekdoc
geekdocEditPath: edit/master/exampleSite/content geekdocEditPath: edit/master/exampleSite/content
geekdocSearch: true geekdocSearch: true

View file

@ -5,11 +5,11 @@ title: Documentation
<!-- markdownlint-capture --> <!-- markdownlint-capture -->
<!-- markdownlint-disable MD033 --> <!-- markdownlint-disable MD033 -->
<span class="badge-placeholder">[![Build Status](https://img.shields.io/drone/build/xoxys/hugo-geekdoc?logo=drone)](https://cloud.drone.io/xoxys/hugo-geekdoc)</span> <span class="badge-placeholder">[![Build Status](https://img.shields.io/drone/build/thegeeklab/hugo-geekdoc?logo=drone)](https://cloud.drone.io/thegeeklab/hugo-geekdoc)</span>
<span class="badge-placeholder">[![Hugo Version](https://img.shields.io/badge/hugo-0.65-blue.svg)](https://gohugo.io)</span> <span class="badge-placeholder">[![Hugo Version](https://img.shields.io/badge/hugo-0.65-blue.svg)](https://gohugo.io)</span>
<span class="badge-placeholder">[![GitHub release](https://img.shields.io/github/v/release/xoxys/hugo-geekdoc)](https://github.com/xoxys/hugo-geekdoc/releases/latest)</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/xoxys/hugo-geekdoc)](https://github.com/xoxys/hugo-geekdoc/graphs/contributors)</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/xoxys/hugo-geekdoc)](https://github.com/xoxys/hugo-geekdoc/blob/master/LICENSE)</span> <span class="badge-placeholder">[![License: MIT](https://img.shields.io/github/license/thegeeklab/hugo-geekdoc)](https://github.com/thegeeklab/hugo-geekdoc/blob/master/LICENSE)</span>
<!-- markdownlint-restore --> <!-- markdownlint-restore -->

View file

@ -2,7 +2,7 @@ Buttons are styled links that can lead to local page or external link.
```tpl ```tpl
{{</* button relref="/" [class="..."] */>}}Get Home{{</* /button */>}} {{</* button relref="/" [class="..."] */>}}Get Home{{</* /button */>}}
{{</* button href="https://github.com/xoxys/hugo-geekdoc" */>}}Contribute{{</* /button */>}} {{</* button href="https://github.com/thegeeklab/hugo-geekdoc" */>}}Contribute{{</* /button */>}}
``` ```
## Example ## Example
@ -10,6 +10,6 @@ Buttons are styled links that can lead to local page or external link.
<!-- spellchecker-disable --> <!-- spellchecker-disable -->
{{< button relref="/" >}}Get Home{{< /button >}} {{< button relref="/" >}}Get Home{{< /button >}}
{{< button href="https://github.com/xoxys/hugo-geekdoc" >}}Contribute{{< /button >}} {{< button href="https://github.com/thegeeklab/hugo-geekdoc" >}}Contribute{{< /button >}}
<!-- spellchecker-enable --> <!-- spellchecker-enable -->

View file

@ -1,6 +1,6 @@
If you want to customize the color scheme of the theme to give it your individual touch you are just a few lines CSS away. In general, you have to override the defaults, the easiest way to do so is to create a `static/custom.css` file right in your site root. If you want to customize the color scheme of the theme to give it your individual touch you are just a few lines CSS away. In general, you have to override the defaults, the easiest way to do so is to create a `static/custom.css` file right in your site root.
All necessary class names are listed below. If you miss some classes required for a color scheme you are very welcome to create an [Issue](https://github.com/xoxys/hugo-geekdoc/issues) or Pull Request. For some inspiration you can have a look at [https://www.color-hex.com/color-palettes/](https://www.color-hex.com/). The following listing use the _HC-primary_ color palette as an example: All necessary class names are listed below. If you miss some classes required for a color scheme you are very welcome to create an [Issue](https://github.com/thegeeklab/hugo-geekdoc/issues) or Pull Request. For some inspiration you can have a look at [https://www.color-hex.com/color-palettes/](https://www.color-hex.com/). The following listing use the _HC-primary_ color palette as an example:
<!-- markdownlint-disable --> <!-- markdownlint-disable -->
<!-- spellchecker-disable --> <!-- spellchecker-disable -->

View file

@ -51,7 +51,7 @@ enableGitInfo = true
# (Optional, default none) Set source repository location # (Optional, default none) Set source repository location
# Used for 'Edit this page' links # Used for 'Edit this page' links
# You can also specify this parameter per page in front matter. # You can also specify this parameter per page in front matter.
geekdocRepo = "https://github.com/xoxys/hugo" geekdocRepo = "https://github.com/thegeeklab/hugo"
# (Optional, default none) Enable 'Edit this page' links. Requires 'GeekdocRepo' param # (Optional, default none) Enable 'Edit this page' links. Requires 'GeekdocRepo' param
# and path must point to 'content' directory of repo. # and path must point to 'content' directory of repo.
@ -126,7 +126,7 @@ params:
# (Optional, default none) Set source repository location # (Optional, default none) Set source repository location
# Used for 'Edit this page' links # Used for 'Edit this page' links
# You can also specify this parameter per page in front matter. # You can also specify this parameter per page in front matter.
geekdocRepo: "https://github.com/xoxys/hugo-geekdoc" geekdocRepo: "https://github.com/thegeeklab/hugo-geekdoc"
# (Optional, default none) Enable "Edit this page" links. Requires 'GeekdocRepo' param # (Optional, default none) Enable "Edit this page" links. Requires 'GeekdocRepo' param
# and path must point to 'content' directory of repo. # and path must point to 'content' directory of repo.
@ -174,7 +174,7 @@ geekdocToC = 3
geekdocBreadcrumb = false geekdocBreadcrumb = false
# Set source repository location # Set source repository location
geekdocRepo = "https://github.com/xoxys/hugo-geekdoc" geekdocRepo = "https://github.com/thegeeklab/hugo-geekdoc"
# Enable "Edit this page" links. Requires 'GeekdocRepo' param and path must point # Enable "Edit this page" links. Requires 'GeekdocRepo' param and path must point
# to 'content' directory of repo. # to 'content' directory of repo.
@ -211,7 +211,7 @@ geekdocToC: 3
geekdocBreadcrumb: false geekdocBreadcrumb: false
# Set source repository location # Set source repository location
geekdocRepo: "https://github.com/xoxys/hugo-geekdoc" geekdocRepo: "https://github.com/thegeeklab/hugo-geekdoc"
# Enable "Edit this page" links. Requires 'GeekdocRepo' param and path must point # Enable "Edit this page" links. Requires 'GeekdocRepo' param and path must point
# to 'content' directory of repo. # to 'content' directory of repo.

View file

@ -77,7 +77,7 @@ Download and extract the latest release bundle into the theme directory.
```Shell ```Shell
mkdir -p themes/hugo-geekdoc/ mkdir -p themes/hugo-geekdoc/
curl -L https://github.com/xoxys/hugo-geekdoc/releases/latest/download/hugo-geekdoc.tar.gz | tar -xz -C themes/hugo-geekdoc/ --strip-components=1 curl -L https://github.com/thegeeklab/hugo-geekdoc/releases/latest/download/hugo-geekdoc.tar.gz | tar -xz -C themes/hugo-geekdoc/ --strip-components=1
``` ```
### Option 2: Clone the GitHub repository ### Option 2: Clone the GitHub repository
@ -92,7 +92,7 @@ run the described steps as well.
Clone the Geekdoc git repository. Clone the Geekdoc git repository.
```Shell ```Shell
git clone https://github.com/xoxys/hugo-geekdoc.git themes/geekdoc git clone https://github.com/thegeeklab/hugo-geekdoc.git themes/geekdoc
``` ```
Build required theme assets e.g. CSS files and SVG sprites with `gulp`. Build required theme assets e.g. CSS files and SVG sprites with `gulp`.

View file

@ -4,10 +4,10 @@ more:
ref: "/posts" ref: "/posts"
icon: "notification" icon: "notification"
- name: Releases - name: Releases
ref: "https://github.com/xoxys/hugo-geekdoc/releases" ref: "https://github.com/thegeeklab/hugo-geekdoc/releases"
external: true external: true
icon: "download" icon: "download"
- name: "View Source" - name: "View Source"
ref: "https://github.com/xoxys/hugo-geekdoc" ref: "https://github.com/thegeeklab/hugo-geekdoc"
external: true external: true
icon: "github" icon: "github"

View file

@ -26,5 +26,5 @@
{{ end -}} {{ end -}}
{{ "<!--" | safeHTML -}} {{ "<!--" | safeHTML -}}
Made with Geekdoc theme https://github.com/xoxys/hugo-geekdoc Made with Geekdoc theme https://github.com/thegeeklab/hugo-geekdoc
{{- "-->" | safeHTML }} {{- "-->" | safeHTML }}

View file

@ -8,7 +8,7 @@
}, },
"repository": { "repository": {
"type": "git", "type": "git",
"url": "https://github.com/xoxys/hugo-geekdoc" "url": "https://github.com/thegeeklab/hugo-geekdoc"
}, },
"author": "Robert Kaussow", "author": "Robert Kaussow",
"license": "MIT", "license": "MIT",

View file

@ -1,6 +1,6 @@
name = "Geekdoc" name = "Geekdoc"
license = "MIT" license = "MIT"
licenselink = "https://github.com/xoxys/hugo-geekdoc/blob/master/LICENSE" licenselink = "https://github.com/thegeeklab/hugo-geekdoc/blob/master/LICENSE"
description = "Hugo theme made for documentation" description = "Hugo theme made for documentation"
homepage = "https://geekdocs.de/" homepage = "https://geekdocs.de/"
tags = ["docs", "documentation", "responsive", "simple"] tags = ["docs", "documentation", "responsive", "simple"]