initial commit

exampleSite/config.yaml

@@ -0,0 +1,55 @@
+# hugo server --minify --themesDir ... --baseURL=http://0.0.0.0:1313
+
+baseURL: https://example.com/
+title: Geekdoc
+theme: hugo-geekdoc
+pygmentsUseClasses: true
+pygmentsCodeFences: true
+
+# Geekdoc configuration
+disablePathToLower: true
+enableGitInfo: true
+
+# Needed for mermaid/katex shortcodes
+markup:
+  goldmark:
+    renderer:
+      unsafe: true
+  tableOfContents:
+    startLevel: 1
+
+params:
+  # (Optional, default 6) Set how many table of contents levels to be showed on page.
+  # Use false to hide ToC, note that 0 will default to 6 (https://gohugo.io/functions/default/)
+  # You can also specify this parameter per page in front matter
+  GeekdocToC: 3
+
+  # (Optional, default none) Set the path to a logo for the Geekdoc. If the logo is
+  # /static/logo.png then the path would be logo.png
+  # GeekdocLogo: /logo.png
+
+  # (Optional, default none) Set leaf bundle to render as side menu
+  # When not specified file structure and weights will be used
+  # GeekdocMenuBundle: /menu
+
+  # (Optional, default docs) Specify section of content to render as menu
+  # You can also set value to '*' to render all sections to menu
+  GeekdocSection: docs
+
+  # Set source repository location.
+  # Used for 'Last Modified' and 'Edit this page' links.
+  GeekdocRepo: https://github.com/xoxys/hugo-geeekdoc
+
+  # Enable "Edit this page" links for 'doc' page type.
+  # Disabled by default. Uncomment to enable. Requires 'GeekdocRepo' param.
+  # Path must point to 'content' directory of repo.
+  GeekdocEditPath: edit/master/exampleSite/content
+
+  # Configure the date format used on the pages
+  # - In git information
+  # - In blog posts
+  GeekdocDateFormat: "Jan 2, 2006"
+
+  # (Optional, default true) Enables search function with flexsearch,
+  # Index is built on fly, therefore it might slowdown your website.
+  GeekdocSearch: true

exampleSite/content/_index.md

@@ -0,0 +1,15 @@
+---
+title: Documentation
+---
+
+## Features
+
+- Clean simple design
+- Light and mobile-friendly
+- Customisable
+- Zero initial configuration
+- Handy shortcodes
+
+## Requirements
+
+- Hugo 0.55 or higher

exampleSite/content/posts/_index.md

@@ -0,0 +1,7 @@
+---
+title: News
+type: posts
+weight: 10
+listonly: true
+---
+

exampleSite/content/posts/hello_geekdoc.md

@@ -0,0 +1,9 @@
+---
+title: Hello Geekdoc
+type: posts
+date: 2020-01-06
+---
+
+This is the first release of the Geekdoc theme.
+
+Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.

exampleSite/content/posts/initial_release.md

@@ -0,0 +1,9 @@
+---
+title: Initial release
+type: posts
+date: 2020-01-08
+---
+
+This is the first release of the Geekdoc theme.
+
+Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet. Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua. At vero eos et accusam et justo duo dolores et ea rebum. Stet clita kasd gubergren, no sea takimata sanctus est Lorem ipsum dolor sit amet.

exampleSite/content/shortcodes/buttons.md

@@ -0,0 +1,11 @@
+Buttons are styled links that can lead to local page or external link.
+
+```tpl
+{{</* button relref="/" [class="..."] */>}}Get Home{{</* /button */>}}
+{{</* button href="https://github.com/xoxys/hugo-geekdoc" */>}}Contribute{{</* /button */>}}
+```
+
+## Example
+
+{{< button relref="/" >}}Get Home{{< /button >}}
+{{< button href="https://github.com/xoxys/hugo-geekdoc" >}}Contribute{{< /button >}}

exampleSite/content/shortcodes/columns.md

@@ -0,0 +1,43 @@
+Columns help organize shorter pieces of content horizontally for readability.
+
+
+```html
+{{</* columns */>}} <!-- begin columns block -->
+# Left Content
+Lorem markdownum insigne...
+
+<---> <!-- magic sparator, between columns -->
+
+# Mid Content
+Lorem markdownum insigne...
+
+<---> <!-- magic sparator, between columns -->
+
+# Right Content
+Lorem markdownum insigne...
+{{</* /columns */>}}
+```
+
+## Example
+
+{{< columns >}}
+## Left Content
+Lorem markdownum insigne. Olympo signis Delphis! Retexi Nereius nova develat
+stringit, frustra Saturnius uteroque inter! Oculis non ritibus Telethusa
+protulit, sed sed aere valvis inhaesuro Pallas animam: qui _quid_, ignes.
+Miseratus fonte Ditis conubia.
+
+<--->
+
+## Mid Content
+Lorem markdownum insigne. Olympo signis Delphis! Retexi Nereius nova develat
+stringit, frustra Saturnius uteroque inter!
+
+<--->
+
+## Right Content
+Lorem markdownum insigne. Olympo signis Delphis! Retexi Nereius nova develat
+stringit, frustra Saturnius uteroque inter! Oculis non ritibus Telethusa
+protulit, sed sed aere valvis inhaesuro Pallas animam: qui _quid_, ignes.
+Miseratus fonte Ditis conubia.
+{{< /columns >}}

exampleSite/content/shortcodes/expand.md

@@ -0,0 +1,33 @@
+Expand shortcode can help to decrease clutter on screen by hiding part of text. Expand content by clicking on it.
+
+## Example
+### Default
+
+```tpl
+{{</* expand */>}}
+## Markdown content
+Lorem markdownum insigne...
+{{</* /expand */>}}
+```
+
+{{< expand >}}
+## Markdown content
+Lorem markdownum insigne...
+{{< /expand >}}
+
+### With Custom Label
+
+```tpl
+{{</* expand "Custom Label" "..." */>}}
+## Markdown content
+Lorem markdownum insigne...
+{{</* /expand */>}}
+```
+
+{{< expand "Custom Label" "..." >}}
+## Markdown content
+Lorem markdownum insigne. Olympo signis Delphis! Retexi Nereius nova develat
+stringit, frustra Saturnius uteroque inter! Oculis non ritibus Telethusa
+protulit, sed sed aere valvis inhaesuro Pallas animam: qui _quid_, ignes.
+Miseratus fonte Ditis conubia.
+{{< /expand >}}

exampleSite/content/shortcodes/hints.md

@@ -0,0 +1,30 @@
+Hint shortcode can be used as hint/alerts/notification block.
+There are 3 colors to choose: `info`, `warning` and `danger`.
+
+```tpl
+{{</* hint [info|warning|danger] */>}}
+**Markdown content**
+Lorem markdownum insigne. Olympo signis Delphis! Retexi Nereius nova develat
+stringit, frustra Saturnius uteroque inter! Oculis non ritibus Telethusa
+{{</* /hint */>}}
+```
+
+## Example
+
+{{< hint info >}}
+**Markdown content**
+Lorem markdownum insigne. Olympo signis Delphis! Retexi Nereius nova develat
+stringit, frustra Saturnius uteroque inter! Oculis non ritibus Telethusa
+{{< /hint >}}
+
+{{< hint warning >}}
+**Markdown content**
+Lorem markdownum insigne. Olympo signis Delphis! Retexi Nereius nova develat
+stringit, frustra Saturnius uteroque inter! Oculis non ritibus Telethusa
+{{< /hint >}}
+
+{{< hint danger >}}
+**Markdown content**
+Lorem markdownum insigne. Olympo signis Delphis! Retexi Nereius nova develat
+stringit, frustra Saturnius uteroque inter! Oculis non ritibus Telethusa
+{{< /hint >}}

exampleSite/content/shortcodes/mermaid.md

@@ -0,0 +1,40 @@
+---
+menutitle: XXX
+---
+
+[Mermaid](https://mermaidjs.github.io/) is library for generating svg charts and diagrams from text.
+
+## Example
+
+{{< columns >}}
+```tpl
+{{</* mermaid [class="text-center"]*/>}}
+sequenceDiagram
+    Alice->>Bob: Hello Bob, how are you?
+    alt is sick
+        Bob->>Alice: Not so good :(
+    else is well
+        Bob->>Alice: Feeling fresh like a daisy
+    end
+    opt Extra response
+        Bob->>Alice: Thanks for asking
+    end
+{{</* /mermaid */>}}
+```
+
+<--->
+
+{{< mermaid >}}
+sequenceDiagram
+    Alice->>Bob: Hello Bob, how are you?
+    alt is sick
+        Bob->>Alice: Not so good :(
+    else is well
+        Bob->>Alice: Feeling fresh like a daisy
+    end
+    opt Extra response
+        Bob->>Alice: Thanks for asking
+    end
+{{< /mermaid >}}
+
+{{< /columns >}}

exampleSite/content/shortcodes/tabs.md

@@ -0,0 +1,48 @@
+Tabs let you organize content by context, for example installation instructions for each supported platform.
+
+```tpl
+{{</* tabs "uniqueid" */>}}
+{{</* tab "MacOS" */>}} # MacOS Content {{</* /tab */>}}
+{{</* tab "Linux" */>}} # Linux Content {{</* /tab */>}}
+{{</* tab "Windows" */>}} # Windows Content {{</* /tab */>}}
+{{</* /tabs */>}}
+```
+
+## Example
+
+{{< tabs "uniqueid" >}}
+{{< tab "MacOS" >}}
+# MacOS
+
+This is tab **MacOS** content.
+
+Lorem markdownum insigne. Olympo signis Delphis! Retexi Nereius nova develat
+stringit, frustra Saturnius uteroque inter! Oculis non ritibus Telethusa
+protulit, sed sed aere valvis inhaesuro Pallas animam: qui _quid_, ignes.
+Miseratus fonte Ditis conubia.
+{{< /tab >}}
+
+{{< tab "Linux" >}}
+
+# Linux
+
+This is tab **Linux** content.
+
+Lorem markdownum insigne. Olympo signis Delphis! Retexi Nereius nova develat
+stringit, frustra Saturnius uteroque inter! Oculis non ritibus Telethusa
+protulit, sed sed aere valvis inhaesuro Pallas animam: qui _quid_, ignes.
+Miseratus fonte Ditis conubia.
+{{< /tab >}}
+
+{{< tab "Windows" >}}
+
+# Windows
+
+This is tab **Windows** content.
+
+Lorem markdownum insigne. Olympo signis Delphis! Retexi Nereius nova develat
+stringit, frustra Saturnius uteroque inter! Oculis non ritibus Telethusa
+protulit, sed sed aere valvis inhaesuro Pallas animam: qui _quid_, ignes.
+Miseratus fonte Ditis conubia.
+{{< /tab >}}
+{{< /tabs >}}

exampleSite/content/usage/_index.md

@@ -0,0 +1,5 @@
+---
+title: Usage
+---
+
+Test

exampleSite/content/usage/code_blocks.md

@@ -0,0 +1,75 @@
+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:
+```
+`some code`
+```
+
+**Example:** `some code`
+
+## Code blocks
+Codeblocks can be uses without language specification:
+
+````
+```
+some code
+```
+````
+
+**Example:**
+
+```
+some code
+```
+
+... or if you need language specific syntax highlighting:
+
+````
+```Shell
+# some code
+echo "Hello world"
+```
+````
+
+**Example:**
+
+```Shell
+# some code
+echo "Hello World"
+```
+
+## Highlight shortcode
+
+Hugo has a build-in shortcode for syntax highlighting. To work properly with this theme, you have to set following options in your sites config:
+
+{{< 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
+{{</* highlight Shell "linenos=table" */>}}
+# some code
+echo "Hello World"
+{{</* /highlight */>}}
+```
+
+**Example:**
+
+{{< highlight Shell "linenos=table" >}}
+# some code
+echo "Hello World"
+{{< /highlight >}}

exampleSite/content/usage/menus.md

@@ -0,0 +1 @@
+...