diff --git a/.drone.yml b/.drone.yml index 4ea2024..55b6b07 100644 --- a/.drone.yml +++ b/.drone.yml @@ -31,7 +31,7 @@ steps: - name: link-validation image: thegeeklab/link-validator commands: - - link-validator -ro --exclude "https://github.com/thegeeklab/hugo-geekdoc/edit/master/*" + - link-validator -ro --exclude "https://github.com/thegeeklab/hugo-geekdoc/edit/main/*" environment: LINK_VALIDATOR_BASE_DIR: exampleSite/public @@ -74,7 +74,7 @@ steps: trigger: ref: - - refs/heads/master + - refs/heads/main - refs/tags/** - refs/pull/** @@ -133,7 +133,7 @@ steps: trigger: ref: - - refs/heads/master + - refs/heads/main - refs/tags/** - refs/pull/** @@ -173,10 +173,10 @@ steps: - 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/master + - refs/heads/main - refs/tags/** -- name: assets-master +- name: assets-main image: node:lts commands: - npm install > /dev/null @@ -218,12 +218,12 @@ steps: strip_prefix: exampleSite/public/ when: ref: - - refs/heads/master + - refs/heads/main - refs/tags/** trigger: ref: - - refs/heads/master + - refs/heads/main - refs/tags/** - refs/pull/** @@ -258,7 +258,7 @@ steps: trigger: ref: - - refs/heads/master + - refs/heads/main - refs/tags/** status: - success diff --git a/.github/settings.yml b/.github/settings.yml index 31ef313..9ed4e1c 100644 --- a/.github/settings.yml +++ b/.github/settings.yml @@ -11,7 +11,7 @@ repository: has_wiki: false has_downloads: false - default_branch: master + default_branch: main allow_squash_merge: true allow_merge_commit: true @@ -47,7 +47,7 @@ labels: description: This will not be worked on branches: - - name: master + - name: main protection: required_status_checks: strict: true diff --git a/README.md b/README.md index 0b8bc97..f48a152 100644 --- a/README.md +++ b/README.md @@ -4,17 +4,19 @@ [![Hugo Version](https://img.shields.io/badge/hugo-0.65-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/master/LICENSE) +[![License: MIT](https://img.shields.io/github/license/thegeeklab/hugo-geekdoc)](https://github.com/thegeeklab/hugo-geekdoc/blob/main/LICENSE) + +> **Important:** We have switched to 'main' as default branch. The 'master' branch is no longer maintained and will be removed after April 30, 2021! 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/thegeeklab/hugo-geekdoc/blob/master/images/readme.png) +![Desktop and mobile preview](https://github.com/thegeeklab/hugo-geekdoc/blob/main/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/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 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 `gulp` locally and run the default pipeline once to create all required assets. ```Shell # install required packages from package.json @@ -29,16 +31,16 @@ See the [Getting Started Guide](https://geekdocs.de/usage/getting-started/) for ## Contributors Special thanks goes 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/master/CONTRIBUTING.md). +please see the [instructions](https://github.com/thegeeklab/hugo-geekdoc/blob/main/CONTRIBUTING.md). 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/thegeeklab/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/main/LICENSE) file for details. The used SVG icons and generated icon fonts are licensed under the license of the respective icon pack: - Font Awesome: [CC BY 4.0 License](https://github.com/FortAwesome/Font-Awesome#license) - IcoMoon Free Pack: [GPL/CC BY 4.0](https://icomoon.io/#icons-icomoon) -- Material Icons: [Apache License 2.0](https://github.com/google/material-design-icons/blob/master/LICENSE) +- Material Icons: [Apache License 2.0](https://github.com/google/material-design-icons/blob/main/LICENSE) diff --git a/exampleSite/config.yaml b/exampleSite/config.yaml index ba2a06a..c0e8c90 100644 --- a/exampleSite/config.yaml +++ b/exampleSite/config.yaml @@ -25,7 +25,7 @@ params: geekdocToC: 3 geekdocRepo: https://github.com/thegeeklab/hugo-geekdoc - geekdocEditPath: edit/master/exampleSite/content + geekdocEditPath: edit/main/exampleSite/content geekdocSearch: true geekdocSearchShowParent: true diff --git a/exampleSite/content/_index.md b/exampleSite/content/_index.md index 3394c5a..94aad94 100644 --- a/exampleSite/content/_index.md +++ b/exampleSite/content/_index.md @@ -9,7 +9,7 @@ title: Documentation [![Hugo Version](https://img.shields.io/badge/hugo-0.65-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/master/LICENSE) +[![License: MIT](https://img.shields.io/github/license/thegeeklab/hugo-geekdoc)](https://github.com/thegeeklab/hugo-geekdoc/blob/main/LICENSE) diff --git a/exampleSite/content/usage/configuration.md b/exampleSite/content/usage/configuration.md index f686e1d..a949126 100644 --- a/exampleSite/content/usage/configuration.md +++ b/exampleSite/content/usage/configuration.md @@ -57,7 +57,7 @@ enableGitInfo = true # (Optional, default none) Enable 'Edit this page' links. Requires 'GeekdocRepo' param # and path must point to 'content' directory of repo. # You can also specify this parameter per page in front matter. - geekdocEditPath = "edit/master/exampleSite/content" + geekdocEditPath = "edit/main/exampleSite/content" # (Optional, default true) Enables search function with flexsearch. # Index is built on the fly and might slowdown your website. @@ -145,7 +145,7 @@ params: # (Optional, default none) Enable "Edit this page" links. Requires 'GeekdocRepo' param # and path must point to 'content' directory of repo. # You can also specify this parameter per page in front matter. - geekdocEditPath: edit/master/exampleSite/content + geekdocEditPath: edit/main/exampleSite/content # (Optional, default true) Enables search function with flexsearch. # Index is built on the fly and might slowdown your website. @@ -209,7 +209,7 @@ geekdocRepo = "https://github.com/thegeeklab/hugo-geekdoc" # Enable "Edit this page" links. Requires 'GeekdocRepo' param and path must point # to 'content' directory of repo. -geekdocEditPath = "edit/master/exampleSite/content" +geekdocEditPath = "edit/main/exampleSite/content" # Used for 'Edit this page' link, set to '.File.Path' by default. # Can be overwritten by a path relative to 'geekdocEditPath' @@ -256,7 +256,7 @@ geekdocRepo: "https://github.com/thegeeklab/hugo-geekdoc" # Enable "Edit this page" links. Requires 'GeekdocRepo' param and path must point # to 'content' directory of repo. -geekdocEditPath: "edit/master/exampleSite/content" +geekdocEditPath: "edit/main/exampleSite/content" # Used for 'Edit this page' link, set to '.File.Path' by default. # Can be overwritten by a path relative to 'geekdocEditPath' diff --git a/theme.toml b/theme.toml index ba0c195..ea2b86f 100644 --- a/theme.toml +++ b/theme.toml @@ -1,6 +1,6 @@ name = "Geekdoc" license = "MIT" -licenselink = "https://github.com/thegeeklab/hugo-geekdoc/blob/master/LICENSE" +licenselink = "https://github.com/thegeeklab/hugo-geekdoc/blob/main/LICENSE" description = "Hugo theme made for documentation" homepage = "https://geekdocs.de/" tags = ["docs", "documentation", "responsive", "simple"]