disable spellchecker for 'highlight' shortcodes

uci-hugo-doc
Robert Kaussow 2020-06-07 17:42:03 +02:00
parent 9b919b2316
commit d4ee6a6b67
No known key found for this signature in database
GPG Key ID: 65362AE74AF98B61
10 changed files with 21 additions and 24 deletions

View File

@ -1,29 +1,8 @@
([a-zA-Z0-9]+[_=])+\S+
.gdoc.*
Geekdoc Geekdoc
Kaussow Kaussow
(S|s)hortcode[s]? (S|s)hortcode[s]?
hugo-book hugo-book
relref ToC
href
(t|T)o(c|C)
toc-.*
macOS macOS
SVG SVG
[a-z0-9]+Diagram
HC-primary HC-primary
# used color codes
1c388e
324b99
73bfb8
cf5f46
d1d7e8
e4ba48
e66a4e
eb8771
fae1db
fecf50
fef5dc
ffffff

View File

@ -7,5 +7,7 @@ Buttons are styled links that can lead to local page or external link.
## Example ## Example
<!-- 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/xoxys/hugo-geekdoc" >}}Contribute{{< /button >}}
<!-- spellchecker-enable -->

View File

@ -23,7 +23,9 @@ Attributes:
{{</* include file="config.yaml" language="yaml" options="linenos=table,hl_lines=5-6,linenostart=100" */>}} {{</* include file="config.yaml" language="yaml" options="linenos=table,hl_lines=5-6,linenostart=100" */>}}
``` ```
<!-- spellchecker-disable -->
{{< include file="config.yaml" language="yaml" options="linenos=table,hl_lines=5-6,linenostart=100">}} {{< include file="config.yaml" language="yaml" options="linenos=table,hl_lines=5-6,linenostart=100">}}
<!-- spellchecker-enable -->
### Include *.md file ### Include *.md file
@ -38,7 +40,9 @@ If you include markdown files that should not get a menu entry, place them outsi
{{</* include file="static/includes/table.md.part" markdown="true" */>}} {{</* include file="static/includes/table.md.part" markdown="true" */>}}
``` ```
<!-- spellchecker-disable -->
{{< include file="static/includes/table.md.part" markdown="true" >}} {{< include file="static/includes/table.md.part" markdown="true" >}}
<!-- spellchecker-enable -->
### Include *.html file ### Include *.html file

View File

@ -21,6 +21,7 @@ sequenceDiagram
<---> <--->
<!-- spellchecker-disable -->
{{< mermaid class="text-center" >}} {{< mermaid class="text-center" >}}
sequenceDiagram sequenceDiagram
Alice->>Bob: Hello Bob, how are you? Alice->>Bob: Hello Bob, how are you?
@ -33,5 +34,6 @@ sequenceDiagram
Bob->>Alice: Thanks for asking Bob->>Alice: Thanks for asking
end end
{{< /mermaid >}} {{< /mermaid >}}
<!-- spellchecker-enable -->
{{< /columns >}} {{< /columns >}}

View File

@ -1,4 +1,4 @@
The toc-tree shortcode will generate a Table of Content from a section file tree of your content directory. The root of the resulting ToC will be the page on which you define the shortcode. The `toc-tree` shortcode will generate a Table of Content from a section file tree of your content directory. The root of the resulting ToC will be the page on which you define the shortcode.
```tpl ```tpl
{{</* toc-tree */>}} {{</* toc-tree */>}}

View File

@ -4,7 +4,9 @@ Simple wrapper to generate a page Table of Content from a shortcode.
{{</* toc */>}} {{</* toc */>}}
``` ```
<!-- spellchecker-disable -->
{{< toc >}} {{< toc >}}
<!-- spellchecker-enable -->
## Level 1 ## Level 1

View File

@ -3,6 +3,8 @@ title: ToC Tree
geekdocFlatSection: true geekdocFlatSection: true
--- ---
This is just a demo section for the [toc-tree](/shortcodes/toc-tree/) shortcode. This is just a demo section for the <!-- spellchecker-disable -->[toc-tree](/shortcodes/toc-tree/)<!-- spellchecker-enable --> shortcode.
<!-- spellchecker-disable -->
{{< toc-tree >}} {{< toc-tree >}}
<!-- spellchecker-enable -->

View File

@ -1,3 +1,5 @@
Level 1 Level 1
<!-- spellchecker-disable -->
{{< toc-tree >}} {{< toc-tree >}}
<!-- spellchecker-enable -->

View File

@ -4,4 +4,6 @@ title: Level 1.3
Level 1.3 Level 1.3
<!-- spellchecker-disable -->
{{< toc-tree >}} {{< toc-tree >}}
<!-- spellchecker-enable -->

View File

@ -3,6 +3,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: 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 --> <!-- markdownlint-disable -->
<!-- spellchecker-disable -->
{{< highlight CSS "linenos=table" >}} {{< highlight CSS "linenos=table" >}}
/* default link color */ /* default link color */
a { color: #1c388e; } a { color: #1c388e; }
@ -31,6 +32,7 @@ a:visited { color: #73bfb8 }
.gdoc-hint.warning { background: #fef5dc; border-color: #e4ba48; color: black; } .gdoc-hint.warning { background: #fef5dc; border-color: #e4ba48; color: black; }
.gdoc-hint.danger { background: #fae1db; border-color: #cf5f46; color: black; } .gdoc-hint.danger { background: #fae1db; border-color: #cf5f46; color: black; }
{{< /highlight >}} {{< /highlight >}}
<!-- spellchecker-enable -->
<!-- markdownlint-enable --> <!-- markdownlint-enable -->
And that is how the result will looks like. Happy customizing! And that is how the result will looks like. Happy customizing!