diff --git a/.drone.yml b/.drone.yml index 999e329..40560f6 100644 --- a/.drone.yml +++ b/.drone.yml @@ -24,19 +24,19 @@ steps: - hugo-official -s exampleSite/ -b http://localhost/ - name: html-validation - image: xoxys/vnu + image: thegeeklab/vnu commands: - vnu --skip-non-html --also-check-css --errors-only exampleSite/public - name: link-validation - image: xoxys/link-validator + image: thegeeklab/link-validator commands: - link-validator -ro environment: LINK_VALIDATOR_BASE_DIR: exampleSite/public - name: page-validation - image: xoxys/lhci + image: thegeeklab/lhci commands: - lhci autorun environment: @@ -150,7 +150,7 @@ steps: image: byrnedo/alpine-curl commands: - 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 image: klakegg/hugo:0.74.3-ext-alpine @@ -234,6 +234,6 @@ depends_on: --- kind: signature -hmac: 082cef9076e41be30895bc3500bb2ebf888ae24e978e41cea71cd2e45c80b483 +hmac: 548bc9f137bf276ff6415afcf396600cebe4a689e97bd8e0687e3921ee7aad63 ... diff --git a/README.md b/README.md index 4a46574..243bb80 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,18 @@ # 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) -[![GitHub release](https://img.shields.io/github/v/release/xoxys/hugo-geekdoc)](https://github.com/xoxys/hugo-geekdoc/releases/latest) -[![GitHub contributors](https://img.shields.io/github/contributors/xoxys/hugo-geekdoc)](https://github.com/xoxys/hugo-geekdoc/graphs/contributors) -[![License: MIT](https://img.shields.io/github/license/xoxys/hugo-geekdoc)](https://github.com/xoxys/hugo-geekdoc/blob/master/LICENSE) +[![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/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). -![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 -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. @@ -28,10 +28,10 @@ See the [Getting Started Guide](https://geekdocs.de/usage/getting_started/) for ## 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. ## 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. diff --git a/exampleSite/config.yaml b/exampleSite/config.yaml index 0b48d59..6540b1e 100644 --- a/exampleSite/config.yaml +++ b/exampleSite/config.yaml @@ -21,7 +21,7 @@ markup: params: geekdocToC: 3 - geekdocRepo: https://github.com/xoxys/hugo-geekdoc + geekdocRepo: https://github.com/thegeeklab/hugo-geekdoc geekdocEditPath: edit/master/exampleSite/content geekdocSearch: true diff --git a/exampleSite/content/_index.md b/exampleSite/content/_index.md index ba93035..40dda3a 100644 --- a/exampleSite/content/_index.md +++ b/exampleSite/content/_index.md @@ -5,11 +5,11 @@ title: Documentation -[![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) -[![GitHub release](https://img.shields.io/github/v/release/xoxys/hugo-geekdoc)](https://github.com/xoxys/hugo-geekdoc/releases/latest) -[![GitHub contributors](https://img.shields.io/github/contributors/xoxys/hugo-geekdoc)](https://github.com/xoxys/hugo-geekdoc/graphs/contributors) -[![License: MIT](https://img.shields.io/github/license/xoxys/hugo-geekdoc)](https://github.com/xoxys/hugo-geekdoc/blob/master/LICENSE) +[![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/master/LICENSE) diff --git a/exampleSite/content/shortcodes/buttons.md b/exampleSite/content/shortcodes/buttons.md index f633588..47f5b0a 100644 --- a/exampleSite/content/shortcodes/buttons.md +++ b/exampleSite/content/shortcodes/buttons.md @@ -2,7 +2,7 @@ Buttons are styled links that can lead to local page or external link. ```tpl {{}}Get Home{{}} -{{}}Contribute{{}} +{{}}Contribute{{}} ``` ## Example @@ -10,6 +10,6 @@ Buttons are styled links that can lead to local page or external link. {{< 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 >}} diff --git a/exampleSite/content/usage/color-schemes.md b/exampleSite/content/usage/color-schemes.md index e704a61..5c8bd9d 100644 --- a/exampleSite/content/usage/color-schemes.md +++ b/exampleSite/content/usage/color-schemes.md @@ -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. -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: diff --git a/exampleSite/content/usage/configuration.md b/exampleSite/content/usage/configuration.md index e55ccff..873c71b 100644 --- a/exampleSite/content/usage/configuration.md +++ b/exampleSite/content/usage/configuration.md @@ -51,7 +51,7 @@ enableGitInfo = true # (Optional, default none) Set source repository location # Used for 'Edit this page' links # 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 # and path must point to 'content' directory of repo. @@ -126,7 +126,7 @@ params: # (Optional, default none) Set source repository location # Used for 'Edit this page' links # 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 # and path must point to 'content' directory of repo. @@ -174,7 +174,7 @@ geekdocToC = 3 geekdocBreadcrumb = false # 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 # to 'content' directory of repo. @@ -211,7 +211,7 @@ geekdocToC: 3 geekdocBreadcrumb: false # 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 # to 'content' directory of repo. diff --git a/exampleSite/content/usage/getting-started.md b/exampleSite/content/usage/getting-started.md index 0593428..94545c0 100644 --- a/exampleSite/content/usage/getting-started.md +++ b/exampleSite/content/usage/getting-started.md @@ -77,7 +77,7 @@ Download and extract the latest release bundle into the theme directory. ```Shell 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 @@ -92,7 +92,7 @@ run the described steps as well. Clone the Geekdoc git repository. ```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`. diff --git a/exampleSite/data/menu/more.yaml b/exampleSite/data/menu/more.yaml index b036325..d06cadb 100644 --- a/exampleSite/data/menu/more.yaml +++ b/exampleSite/data/menu/more.yaml @@ -4,10 +4,10 @@ more: ref: "/posts" icon: "notification" - name: Releases - ref: "https://github.com/xoxys/hugo-geekdoc/releases" + ref: "https://github.com/thegeeklab/hugo-geekdoc/releases" external: true icon: "download" - name: "View Source" - ref: "https://github.com/xoxys/hugo-geekdoc" + ref: "https://github.com/thegeeklab/hugo-geekdoc" external: true icon: "github" diff --git a/layouts/partials/head.html b/layouts/partials/head.html index f738275..37bfb70 100644 --- a/layouts/partials/head.html +++ b/layouts/partials/head.html @@ -26,5 +26,5 @@ {{ end -}} {{ "" | safeHTML }} diff --git a/package.json b/package.json index 84a04f3..7f5f3f6 100644 --- a/package.json +++ b/package.json @@ -8,7 +8,7 @@ }, "repository": { "type": "git", - "url": "https://github.com/xoxys/hugo-geekdoc" + "url": "https://github.com/thegeeklab/hugo-geekdoc" }, "author": "Robert Kaussow", "license": "MIT", diff --git a/theme.toml b/theme.toml index 68811f7..ba0c195 100644 --- a/theme.toml +++ b/theme.toml @@ -1,6 +1,6 @@ name = "Geekdoc" 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" homepage = "https://geekdocs.de/" tags = ["docs", "documentation", "responsive", "simple"]