chore: normalize mixed casing of code block lang and theme parameters (#647)

This commit is contained in:
Robert Kaussow 2023-06-22 09:45:54 +02:00 committed by GitHub
parent 4b6ba3a53f
commit 23128a3dfa
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
29 changed files with 79 additions and 77 deletions

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,7 +265,7 @@ params:
{{< tabs "page-config" >}}
{{< tab "TOML" >}}
```Toml
```toml
# Set type to 'posts' if you want to render page as blogpost
type = "posts"
@ -288,7 +288,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 +325,7 @@ geekdocAlign = "left"
{{< /tab >}}
{{< tab "YAML" >}}
```Yaml
```yaml
# Set type to 'posts' if you want to render page as blogpost.
type: "posts"
@ -348,7 +348,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