add markdownlint to ci

This commit is contained in:
Robert Kaussow 2020-06-02 00:01:49 +02:00
parent 6d4ec21b43
commit 03ee06ffac
4 changed files with 41 additions and 15 deletions

View file

@ -1,17 +1,20 @@
There are multiple ways to add code blocks. Most of them works out of the box only the Hugo shortcode `<highlight>` need some configuration to work properly.
## Inline code
To display an inline shortcode use single quotes:
```
```plain
`some code`
```
**Example:** `some code`
## Code blocks
Code blocks can be uses without language specification:
````
````markdown
```
some code
```
@ -19,13 +22,13 @@ some code
**Example:**
```
```plain
some code
```
... or if you need language specific syntax highlighting:
````
````markdown
```Shell
# some code
echo "Hello world"
@ -45,22 +48,26 @@ Hugo has a build-in shortcode for syntax highlighting. To work properly with thi
{{< tabs "uniqueid" >}}
{{< tab "TOML" >}}
```TOML
pygmentsUseClasses=true
pygmentsCodeFences=true
```
{{< /tab >}}
{{< tab "YAML" >}}
```YAML
pygmentsUseClasses: true
pygmentsCodeFences: true
```
{{< /tab >}}
{{< /tabs >}}
You can use it like every other shortcode:
```Markdown
```markdown
{{</* highlight Shell "linenos=table" */>}}
# some code
echo "Hello World"
@ -69,7 +76,9 @@ echo "Hello World"
**Example:**
<!-- markdownlint-disable -->
{{< highlight Shell "linenos=table" >}}
# some code
echo "Hello World"
{{< /highlight >}}
<!-- markdownlint-enable -->

View file

@ -2,6 +2,7 @@ If you want to customize the color scheme of the theme to give it your individua
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:
<!-- markdownlint-disable -->
{{< highlight CSS "linenos=table" >}}
/* default link color */
a { color: #1c388e; }
@ -30,6 +31,7 @@ a:visited { color: #73bfb8 }
.gdoc-hint.warning { background: #fef5dc; border-color: #e4ba48; color: black; }
.gdoc-hint.danger { background: #fae1db; border-color: #cf5f46; color: black; }
{{< /highlight >}}
<!-- markdownlint-enable -->
And that is how the result will looks like. Happy customizing!