diff --git a/Documentation/docs-site/themes/docdock/.gitignore b/Documentation/docs-site/themes/docdock/.gitignore new file mode 100644 index 00000000..9381b76c --- /dev/null +++ b/Documentation/docs-site/themes/docdock/.gitignore @@ -0,0 +1,2 @@ +.DS_Store +public/ diff --git a/Documentation/docs-site/themes/docdock/LICENSE.md b/Documentation/docs-site/themes/docdock/LICENSE.md new file mode 100644 index 00000000..0cf9fcb4 --- /dev/null +++ b/Documentation/docs-site/themes/docdock/LICENSE.md @@ -0,0 +1,22 @@ +The MIT License (MIT) + +Copyright (c) 2014 Grav +Copyright (c) 2016 MATHIEU CORNIC +Copyright (c) 2017 Valere JEANTET + +Permission is hereby granted, free of charge, to any person obtaining a copy of +this software and associated documentation files (the "Software"), to deal in +the Software without restriction, including without limitation the rights to +use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of +the Software, and to permit persons to whom the Software is furnished to do so, +subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS +FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR +COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER +IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN +CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. diff --git a/Documentation/docs-site/themes/docdock/README.md b/Documentation/docs-site/themes/docdock/README.md new file mode 100644 index 00000000..f1a00e33 --- /dev/null +++ b/Documentation/docs-site/themes/docdock/README.md @@ -0,0 +1,34 @@ +# Hugo docDock Theme + +This repository contains a theme for [Hugo](https://gohugo.io/), based on great [Matcornic Learn theme](https://github.com/matcornic/hugo-theme-learn/). + +Visit the [theme documentation](http://docdock.netlify.com/) to see what is going on. It is actually built with this theme. + +# Main features + +- Search +- **Unlimited menu levels** +- RevealJS presentation from markdown (embededed or fullscreen page) +- Attachments files +- List child pages +- Include segment of content from one page in another (Excerpt) +- Automatic next/prev buttons to navigate through menu entries +- Mermaid diagram +- Icons, Buttons, Alerts, Panels, Tip/Note/Info/Warning boxes +- Image resizing, shadow... +- Customizable look and feel + +## Installation +Navigate to your themes folder in your Hugo site and use the following commands: +``` +$ cd themes +$ git clone https://github.com/vjeantet/hugo-theme-docdock.git docdock +``` + +Check that your Hugo version is minimum `0.25` with `hugo version`. + + + +## Usage + +- [Visit the documentation](http://docdock.netlify.com/) \ No newline at end of file diff --git a/Documentation/docs-site/themes/docdock/archetypes/default.md b/Documentation/docs-site/themes/docdock/archetypes/default.md new file mode 100644 index 00000000..dd9d7941 --- /dev/null +++ b/Documentation/docs-site/themes/docdock/archetypes/default.md @@ -0,0 +1,9 @@ ++++ +title= "{{ replace .TranslationBaseName "-" " " | title }}" +date= {{ .Date }} +description = "" +draft= true ++++ + +Lorem Ipsum. +Notice `draft` is set to true. diff --git a/Documentation/docs-site/themes/docdock/archetypes/slide.md b/Documentation/docs-site/themes/docdock/archetypes/slide.md new file mode 100644 index 00000000..e40a913d --- /dev/null +++ b/Documentation/docs-site/themes/docdock/archetypes/slide.md @@ -0,0 +1,46 @@ ++++ +title = "Slide title" +type="slide" + +theme = "league" +[revealOptions] +transition= 'concave' +controls= true +progress= true +history= true +center= true ++++ + +# Slide 1 + +___ + +## Slide 1.1 + +- Turn off alarm +- Get out of bed + +___ + +## Slide 1.2 + +- Eat eggs +- Drink coffee + +--- + +# Slide 2 + +___ + +## Slide 2.1 + +- Eat spaghetti +- Drink wine + +___ + +## Slide 2.2 + +- Get in bed +- Count sheep \ No newline at end of file diff --git a/Documentation/docs-site/themes/docdock/exampleSite/config.toml b/Documentation/docs-site/themes/docdock/exampleSite/config.toml new file mode 100644 index 00000000..e229f9ce --- /dev/null +++ b/Documentation/docs-site/themes/docdock/exampleSite/config.toml @@ -0,0 +1,43 @@ +baseURL = "/" +languageCode = "en-us" +DefaultContentLanguage = "en" + +title = "Docdock" +theme = "hugo-theme-docdock" +themesdir = "../.." + +[params] +editURL = "https://github.com/vjeantet/hugo-theme-docdock/edit/master/exampleSite/content/" +noHomeIcon = false # default is false +noSearch = false # default is false +showVisitedLinks = true # default is false +# themeStyle = "theme" # overide base css +themeVariant = "" # choose theme variant "green", "gold" , "gray", "blue" (default) +ordersectionsby = "weight" # ordersectionsby = "title" + +[outputs] +home = [ "HTML", "RSS", "JSON"] + + +[[menu.shortcuts]] +pre = "