From d4ee6a6b678d0e91a750b15df8dba50cc50872e6 Mon Sep 17 00:00:00 2001 From: Robert Kaussow Date: Sun, 7 Jun 2020 17:42:03 +0200 Subject: [PATCH] disable spellchecker for 'highlight' shortcodes --- .dictionary | 23 +------------------ exampleSite/content/shortcodes/buttons.md | 2 ++ exampleSite/content/shortcodes/includes.md | 4 ++++ exampleSite/content/shortcodes/mermaid.md | 2 ++ exampleSite/content/shortcodes/toc-tree.md | 2 +- exampleSite/content/shortcodes/toc.md | 2 ++ exampleSite/content/toc-tree/_index.md | 4 +++- .../content/toc-tree/level-1/_index.md | 2 ++ .../toc-tree/level-1/level-1-3/_index.md | 2 ++ exampleSite/content/usage/color_schemes.md | 2 ++ 10 files changed, 21 insertions(+), 24 deletions(-) diff --git a/.dictionary b/.dictionary index 0145b1c..b03077e 100644 --- a/.dictionary +++ b/.dictionary @@ -1,29 +1,8 @@ -([a-zA-Z0-9]+[_=])+\S+ -.gdoc.* - Geekdoc Kaussow (S|s)hortcode[s]? hugo-book -relref -href -(t|T)o(c|C) -toc-.* +ToC macOS SVG -[a-z0-9]+Diagram HC-primary - -# used color codes -1c388e -324b99 -73bfb8 -cf5f46 -d1d7e8 -e4ba48 -e66a4e -eb8771 -fae1db -fecf50 -fef5dc -ffffff diff --git a/exampleSite/content/shortcodes/buttons.md b/exampleSite/content/shortcodes/buttons.md index b9f2a11..4444820 100644 --- a/exampleSite/content/shortcodes/buttons.md +++ b/exampleSite/content/shortcodes/buttons.md @@ -7,5 +7,7 @@ Buttons are styled links that can lead to local page or external link. ## Example + {{< button relref="/" >}}Get Home{{< /button >}} {{< button href="https://github.com/xoxys/hugo-geekdoc" >}}Contribute{{< /button >}} + diff --git a/exampleSite/content/shortcodes/includes.md b/exampleSite/content/shortcodes/includes.md index 8066eaa..fc0e675 100644 --- a/exampleSite/content/shortcodes/includes.md +++ b/exampleSite/content/shortcodes/includes.md @@ -23,7 +23,9 @@ Attributes: {{}} ``` + {{< include file="config.yaml" language="yaml" options="linenos=table,hl_lines=5-6,linenostart=100">}} + ### 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 *.html file diff --git a/exampleSite/content/shortcodes/mermaid.md b/exampleSite/content/shortcodes/mermaid.md index cf8a45c..d0f637f 100644 --- a/exampleSite/content/shortcodes/mermaid.md +++ b/exampleSite/content/shortcodes/mermaid.md @@ -21,6 +21,7 @@ sequenceDiagram <---> + {{< mermaid class="text-center" >}} sequenceDiagram Alice->>Bob: Hello Bob, how are you? @@ -33,5 +34,6 @@ sequenceDiagram Bob->>Alice: Thanks for asking end {{< /mermaid >}} + {{< /columns >}} diff --git a/exampleSite/content/shortcodes/toc-tree.md b/exampleSite/content/shortcodes/toc-tree.md index 9d01f68..c5671ea 100644 --- a/exampleSite/content/shortcodes/toc-tree.md +++ b/exampleSite/content/shortcodes/toc-tree.md @@ -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 {{}} diff --git a/exampleSite/content/shortcodes/toc.md b/exampleSite/content/shortcodes/toc.md index 4911001..d2cbada 100644 --- a/exampleSite/content/shortcodes/toc.md +++ b/exampleSite/content/shortcodes/toc.md @@ -4,7 +4,9 @@ Simple wrapper to generate a page Table of Content from a shortcode. {{}} ``` + {{< toc >}} + ## Level 1 diff --git a/exampleSite/content/toc-tree/_index.md b/exampleSite/content/toc-tree/_index.md index 1fc216f..2576dcd 100644 --- a/exampleSite/content/toc-tree/_index.md +++ b/exampleSite/content/toc-tree/_index.md @@ -3,6 +3,8 @@ title: ToC Tree geekdocFlatSection: true --- -This is just a demo section for the [toc-tree](/shortcodes/toc-tree/) shortcode. +This is just a demo section for the [toc-tree](/shortcodes/toc-tree/) shortcode. + {{< toc-tree >}} + diff --git a/exampleSite/content/toc-tree/level-1/_index.md b/exampleSite/content/toc-tree/level-1/_index.md index 5fcb86f..f0eb0d0 100644 --- a/exampleSite/content/toc-tree/level-1/_index.md +++ b/exampleSite/content/toc-tree/level-1/_index.md @@ -1,3 +1,5 @@ Level 1 + {{< toc-tree >}} + diff --git a/exampleSite/content/toc-tree/level-1/level-1-3/_index.md b/exampleSite/content/toc-tree/level-1/level-1-3/_index.md index ac3b530..dbeee29 100644 --- a/exampleSite/content/toc-tree/level-1/level-1-3/_index.md +++ b/exampleSite/content/toc-tree/level-1/level-1-3/_index.md @@ -4,4 +4,6 @@ title: Level 1.3 Level 1.3 + {{< toc-tree >}} + diff --git a/exampleSite/content/usage/color_schemes.md b/exampleSite/content/usage/color_schemes.md index ab53349..520e21f 100644 --- a/exampleSite/content/usage/color_schemes.md +++ b/exampleSite/content/usage/color_schemes.md @@ -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: + {{< highlight CSS "linenos=table" >}} /* default link color */ a { color: #1c388e; } @@ -31,6 +32,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 >}} + And that is how the result will looks like. Happy customizing!