codefresh 0.78.2

package/docs/themes/docdock/exampleSite/content/getting-start/_index.md

@@ -0,0 +1,12 @@
++++
+title = "Getting started"
+description = ""
+weight = 1
+alwaysopen = true
++++
+
+## Requirements
+
+Download [Hugo binary](https://gohugo.io/overview/installing/) for your OS (Windows, Linux, Mac) : it’s that simple
+
+{{%children style="h2" description="true"%}}

package/docs/themes/docdock/exampleSite/content/getting-start/configuration.md

@@ -0,0 +1,56 @@
++++
+title = "Configuration"
+description = ""
+weight = 2
++++
+
+When building the website, you can set a theme by using `--theme` option. We suggest you to edit your configuration file and set the theme by default. Example with `config.toml` format.
+<!--more-->
+
+Import sample config from sample site to Hugo root:
+
+```
+$ cp themes/docdock/exampleSite/config.toml .
+```
+
+Change following `config.toml` line as needed, depending on method above:
+```
+theme = "<hugo-theme-docdock-dir-name>"
+```
+Comment out following line, so default `themes/` will be used:
+
+```
+# themesdir = "../.."
+```
+
+
+{{%excerpt%}}
+## Activate search
+
+If not already present, add the follow lines to the `config.toml` file.
+
+```toml
+[outputs]
+home = [ "HTML", "RSS", "JSON"]
+```
+{{% /excerpt%}}
+
+
+LUNRJS search index file will be generated on content changes.
+
+#### (Bonus)
+Create empty file `.gitkeep` inside `public/` and add following to `.gitignore`.  This way it will keep repo smaller and won't bring build result files and errors to remote checkout places:
+```
+/public/*
+!/public/.gitkeep
+```
+
+### Preview site
+```
+$ hugo server
+```
+to browse site on http://localhost:1313
+
+## Your website's content
+
+Find out how to [create]({{%relref "create-page/_index.md"%}}) and [organize your content]({{%relref "content-organisation/_index.md"%}}) quickly and intuitively.

package/docs/themes/docdock/exampleSite/content/getting-start/installation.md

@@ -0,0 +1,83 @@
++++
+title = "Installation"
+description = ""
+weight = 1
++++
+
+{{% alert theme="warning" %}}HUGO **v0.32** minimum required to use this theme{{%/alert%}}
+
+The following steps are here to help you initialize your new website. If you don’t know Hugo at all, we strongly suggest you to train by following this [great documentation for beginners](https://gohugo.io/overview/quickstart/).
+<!--more-->
+
+## Installation
+
+We assume that all changes to Hugo content and customizations are going to be tracked by git (GitHub, Bitbucket etc.). Develop locally, build on remote system.
+
+Before start real work:
+
+1. Initialize Hugo
+2. Install DocDock theme
+3. Configure DocDock and Hugo
+
+### Prepare empty Hugo site
+
+Create empty directory, which will be root of your Hugo project. Navigate there and let Hugo to create minimal required directory structure:
+```
+$ hugo new site .
+```
+AFTER that, initialize this as git directory where to track further changes
+```
+$ git init
+```
+
+Next, there are at least three ways to install DocDock (first recommended):
+
+1. **As git submodule**
+2. As git clone
+3. As direct copy (from ZIP)
+
+Navigate to your themes folder in your Hugo site and use perform one of following scenarios.
+
+### 1. Install DocDock as git submodule
+
+DocDock will be added like a dependency repo to original project. When using CI tools like Netlify, Jenkins etc., submodule method is required, or you will get `theme not found` issues. Same applies when building site on remote server trough SSH.
+
+If submodule is no-go, use 3rd option.
+
+On your root of Hugo execute:
+
+```
+$ git submodule add https://github.com/vjeantet/hugo-theme-docdock.git themes/docdock
+```
+Next initialize submodule for parent git repo:
+
+```
+$ git submodule init
+$ git submodule update
+```
+
+Now you are ready to add content and customize looks. Do not change any file inside theme directory.
+
+If you want to freeze changes to DocDock theme itself and use still submodules, fork private copy of DocDock and use that as submodule. When you are ready to update theme, just pull changes from origin to your private fork.
+
+### 2. Install DocDock simply as git clone
+
+This method results that files are checked out locally, but won't be visible from parent git repo. Probably you will build site locally with `hugo` command and use result from `public/` on your own.
+
+```
+$ git clone https://github.com/vjeantet/hugo-theme-docdock.git themes/docdock
+```
+
+
+### 3. Install DocDock from ZIP
+
+All files from theme will be tracked inside parent repo, to update it, have to override files in theme. [{{%icon download%}} download following zip](https://github.com/vjeantet/hugo-theme-docdock/archive/master.zip) and extract inside `themes/`.
+
+```
+https://github.com/vjeantet/hugo-theme-docdock/archive/master.zip
+```
+Name of theme in next step will be `hugo-theme-docdock-master`, can rename as you wish.
+
+## Configuration
+
+[Follow instructions here]({{%relref "configuration.md"%}})

package/docs/themes/docdock/exampleSite/content/search/_index.md

@@ -0,0 +1,13 @@
++++
+title = "About the Search Engine"
+description = ""
+weight = 40
++++
+
+{{%excerpt-include filename="getting-start/configuration.md" /%}}
+
+
+Docdock theme uses the last improvement available in hugo version 20+ to generate a json index file ready to be consumed by lunr.js javascript search engine.
+
+
+{{%note%}}hugo generate lunrjs index.json at the root of `public` folder if the site only has one language or within each language subfolder. <br/>When you build the site with `hugo server`, hugo generates it internally and of course it don't show up in the filesystem{{%/note%}}

package/docs/themes/docdock/exampleSite/content/shortcodes/_index.md

@@ -0,0 +1,10 @@
++++
+title = "Shortcodes"
+description = ""
+date = "2017-04-24T18:36:24+02:00"
+weight = 30
++++
+
+A bunch of Shortcodes are available with this theme :
+
+{{%children style="card" description="true" %}}

package/docs/themes/docdock/exampleSite/content/shortcodes/alert.md

@@ -0,0 +1,30 @@
++++
+title = "alert"
+description = "The alert shortcode allows you to highlight information in your page."
++++
+
+The `alert` shortcode allow you to highlight information in your page. They create a colored box surrounding your text, like this:
+
+{{%alert%}}**This is** an alert !{{%/alert%}}
+## Usage 
+
+| Parameter | Default | Description |
+|:--|:--|:--|
+| theme | `info` | `success`, `info`,`warning`,`danger` |
+
+{{%alert info%}}
+**Tips :** setting only the theme as argument works too : 
+`{{%/*alert warning*/%}}`  instead of `{{%/*alert theme="warning"*/%}}`
+{{%/alert%}}
+
+## Basic examples
+
+	{{%/* alert theme="info" */%}}**this** is a text{{%/* /alert */%}}
+	{{%/* alert theme="success" */%}}**Yeahhh !** is a text{{%/* /alert */%}}
+	{{%/* alert theme="warning" */%}}**Be carefull** is a text{{%/* /alert */%}}
+	{{%/* alert theme="danger" */%}}**Beware !** is a text{{%/* /alert */%}}
+
+{{% alert theme="info"%}}**this** is an info{{% /alert %}}
+{{% alert theme="success" %}}**Yeahhh !** is an success{{% /alert %}}
+{{% alert theme="warning" %}}**Be carefull** is a warning{{% /alert %}}
+{{% alert theme="danger" %}}**Beware !** is a danger{{% /alert %}}

package/docs/themes/docdock/exampleSite/content/shortcodes/attachments.md

@@ -0,0 +1,59 @@
++++
+title = "attachments"
+description = "The Attachments shortcode displays a list of files attached to a page."
++++
+
+The Attachments shortcode displays a list of files attached to a page.
+Example :
+{{%alert success%}}{{%attachments  /%}}{{%/alert%}}
+
+## Usage
+
+The shortcurt lists files found in a **specific folder**.
+Currently, it support two implementations for pages
+
+1. If your page is a markdown file, attachements must be place in a **folder** named like your page and ending with **.files**.
+
+    > * content
+    >   * _index.md
+    >   * page.files
+    >      * attachment.pdf
+    >   * page.md
+
+2. If your page is a **folder**, attachements must be place in a nested **'files'** folder.
+
+    > * content
+    >   * _index.md
+    >   * page
+    >      * index.md
+    >      * files
+    >          * attachment.pdf
+
+That's all !
+
+{{%alert info%}}**Tip** : Look at this documentation source code on github{{%/alert%}}
+
+### parameters
+
+| Parameter | Default | Description |
+|:--|:--|:--|
+| title | "Attachments" | List's title  |
+| pattern | ".*" | A regular expressions, used to filter the attachments by file name. <br/><br/>{{%alert warning%}}The **pattern** parameter value must be [regular expressions](https://en.wikipedia.org/wiki/Regular_expression).
+
+For example:
+
+* To match a file suffix of 'jpg', use **.*jpg** (not *.jpg).
+* To match file names ending in 'jpg' or 'png', use **.*(jpg|png)**
+
+{{%/alert%}}|
+
+
+## Demo
+### List of attachments ending in pdf or mp4
+
+    {{%/*attachments title="Related files" pattern=".*(pdf|mp4)"/*/%}}
+
+renders as
+
+{{%attachments title="Related files" pattern=".*(pdf|mp4)"/%}}
+

package/docs/themes/docdock/exampleSite/content/shortcodes/button.md

@@ -0,0 +1,37 @@
++++
+title = "button"
+description = "Display an actionable button in your page."
++++
+
+Display an actionable button in your page.
+
+{{<button align="center" href="#" theme="warning" >}} This is a warning button {{< /button >}}
+
+## Usage 
+
+| Parameter | Default | Description |
+|:--|:--|:--|
+| href | "" | The location href to link to |
+| align | "center" | horizontal align button on page |
+| theme | `primary` | `default`, `primary` , `success`,`info`,`warning`,`danger` |
+
+The inner text you place in short code will be displayed as the _button text_
+
+## Demo
+
+	{{</* button href="https://google.com" */>}} go to google {{</* /button */>}}
+	{{</* button href="https://google.com" theme="success" */>}} Success {{</* /button */>}}
+	{{</* button href="https://google.com" theme="info" */>}} Info {{</* /button */>}}
+	{{</* button href="https://google.com" theme="warning" */>}} Warning {{</* /button */>}}
+	{{</* button href="https://google.com" theme="danger" */>}} Danger ! {{</* /button */>}}
+	{{</* button href="https://google.com" theme="default" */>}} Danger ! {{</* /button */>}}
+    
+{{<button href="https://google.com" >}} go to google {{< /button >}}
+{{<button href="https://google.com" theme="success">}} Success {{< /button >}}
+{{<button href="https://google.com" theme="info">}} Info {{< /button >}}
+{{<button href="https://google.com" theme="warning">}} Warning {{< /button >}}
+{{<button href="https://google.com" theme="danger">}} Danger ! {{< /button >}}
+{{<button href="https://google.com" theme="default">}} Danger ! {{< /button >}}
+
+
+

package/docs/themes/docdock/exampleSite/content/shortcodes/children/_index.md

@@ -0,0 +1,46 @@
++++
+title = "children"
+description = "List the child pages of a page"
++++
+
+
+Use the children shortcode to list the child pages of a page and the further descendants (children's children). By default, the shortcode displays links to the child pages.
+
+## Usage
+
+| Parameter | Default | Description |
+|:--|:--|:--|
+| page | _current_ | Specify the page name (section name) to display children for |
+| style | "li" | Choose the style used to display descendants. It could be any HTML tag name, use "card" to display children pages as cards |
+| showhidden | "false" | When true, child pages hidden from the menu will be displayed |
+| description  | "false" | Allows you to include a short text under each page in the list.<br/>when no description exists for the page, children shortcode takes the first 70 words of your content. [read more info about summaries on gohugo.io](https://gohugo.io/content/summaries/)  |
+| depth | 1 | Enter a number to specify the depth of descendants to display. For example, if the value is 2, the shortcode will display 2 levels of child pages. {{%alert success%}}**Tips:** set 999 to get all descendants{{%/alert%}}|
+| sort | none | Sort Children By<br><li><strong>Weight</strong> - to sort on menu order</li><li><strong>Name</strong> - to sort alphabetically on menu label</li><li><strong>Identifier</strong> - to sort alphabetically on identifier set in frontmatter</li><li><strong>URL</strong> - URL</li> |
+
+
+
+## Demo
+
+	{{%/* children  */%}}
+
+{{%children %}}
+
+	{{%/* children description="true"   */%}}
+
+{{%children description="true"   %}}
+
+	{{%/* children depth="3" showhidden="true" */%}}
+
+{{% children depth="3" showhidden="true" %}}
+
+	{{%/* children style="h2" depth="3" description="true" */%}}
+
+{{% children style="h2" depth="3" description="true" %}}
+
+	{{%/* children style="div" depth="999" */%}}
+
+{{% children style="div" depth="999" %}}
+
+	{{%/* children style="card" depth="2"  description="true" */%}}
+
+{{% children style="card" depth="2" description="true" %}}

package/docs/themes/docdock/exampleSite/content/shortcodes/children/children-1/_index.md

@@ -0,0 +1,6 @@
++++
+title = "page 1"
+description = "This is a demo child page"
++++
+
+This is a demo child page

package/docs/themes/docdock/exampleSite/content/shortcodes/children/children-1/children-1-1/_index.md

@@ -0,0 +1,6 @@
++++
+title = "page 1-1"
+description = "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod"
++++
+
+This is a demo child page

package/docs/themes/docdock/exampleSite/content/shortcodes/children/children-1/children-1-1/children-1-1-1/_index.md

@@ -0,0 +1,6 @@
++++
+title = "page 1-1-1"
+description = "This is a demo child page"
++++
+
+This is a demo child page

package/docs/themes/docdock/exampleSite/content/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/_index.md

@@ -0,0 +1,6 @@
++++
+title = "page 1-1-1-1"
+description = "This is a demo child page"
++++
+
+This is a demo child page

package/docs/themes/docdock/exampleSite/content/shortcodes/children/children-1/children-1-1/children-1-1-1/children-1-1-1-1/children-1-1-1-1-1/_index.md

@@ -0,0 +1,6 @@
++++
+title = "page 1-1-1-1-1"
+description = "This is a demo child page"
++++
+
+This is a demo child page

package/docs/themes/docdock/exampleSite/content/shortcodes/children/children-2/_index.md

@@ -0,0 +1,11 @@
++++
+title = "page 2"
+description = ""
++++
+
+Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod
+	tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam,
+	quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo
+	consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse
+	cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non
+	proident, sunt in culpa qui officia deserunt mollit anim id est laborum.	

package/docs/themes/docdock/exampleSite/content/shortcodes/children/children-2/test3.md

@@ -0,0 +1,6 @@
++++
+title = "page test 3"
+description = "This is a page test"
++++
+
+This is a test 3 demo child page

package/docs/themes/docdock/exampleSite/content/shortcodes/children/children-3/_index.md

@@ -0,0 +1,6 @@
++++
+title = "page 3"
+description = "This is a demo child page"
++++
+
+This is a demo child page

package/docs/themes/docdock/exampleSite/content/shortcodes/children/children-4/_index.md

@@ -0,0 +1,7 @@
++++
+title = "page 4"
+description = "This is a demo child page"
+hidden=true
++++
+
+This is a demo child page, not displayed in the menu

package/docs/themes/docdock/exampleSite/content/shortcodes/children/test.md

@@ -0,0 +1,6 @@
++++
+title = "page test"
+description = "This is a page test"
++++
+
+This is a test demo child page

package/docs/themes/docdock/exampleSite/content/shortcodes/excerpt-include.md

@@ -0,0 +1,25 @@
++++
+title = "excerpt-include"
+description = ""
++++
+
+The Excerpt Include shortcode is used to display 'excerpted' (that is, a segment of) content from one page in another.
+Before you can use this shortcode, the excerpt must have been defined using the Excerpt shortcode. {{%alert info%}}Note that you can have more than one Excerpt Include shortcode on a page (although you can have only one Excerpt shortcode on a page).{{%/alert%}}
+
+
+## Usage
+
+| Parameter | Default | Description |
+|:--|:--|:--|
+| filename | **required** | Type the filename of the page that contains the excerpt to be displayed.<br/>Path is relative to the content folder|
+| panel | none | Determines whether docDock will display a panel around the excerpted content. The panel includes the given panel's value and the border of the panel. By default, the panel and title are not shown.|
+
+## Demo
+The paragraph below shows an example of an Excerpt Include shortcode, containing content from an excerpt which we have defined on the Excerpt shortcode page. On the Excerpt Include shortcode below, we have set the options to show both the title of the page and the panel surrounding the content.
+
+	{{%/*excerpt-include filename="shortcodes/excerpt.md" panel="From excerpt page" /*/%}}
+
+{{%excerpt-include filename="shortcodes/excerpt.md" panel="From excerpt page" /%}}
+ 
+> Don't create an excerpt file in the ```/layouts/shortcodes/``` folder. 
+> In this example, ```shortcodes/filename.md``` is part of the ```exampleSite/content``` folder, and ```shortcodes``` is just a path in the ```/content```.

package/docs/themes/docdock/exampleSite/content/shortcodes/excerpt.md

@@ -0,0 +1,39 @@
++++
+title = "excerpt"
+description = "The Excerpt shortcode is used to mark a part of a page's content for re-use."
++++
+
+The Excerpt shortcode is used to mark a part of a page's content for re-use. Defining an excerpt enables other shortcodes, such as the excerpt-include shortcode, to display the marked content elsewhere.
+
+{{%alert warning%}}You can only define one excerpt per page. In other words, you can only add the Excerpt shortcode once to a page.{{%/alert%}}
+
+
+## Usage
+
+| Parameter | Default | Description |
+|:--|:--|:--|
+| hidden | "false" | Controls whether the page content contained in the Excerpt shortcode placeholder is displayed on the page.{{%alert warning%}}Note that this option affects only the page that contains the Excerpt shortcode. It does not affect any pages where the content is reused.{{%/alert%}} |
+
+## Demo
+
+	{{%/*excerpt*/%}}
+	Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod
+	tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam,
+	quis nostrud exercitation **ullamco** laboris nisi ut aliquip ex ea commodo
+	consequat. Duis aute irure dolor in _reprehenderit in voluptate_
+	cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non
+	proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
+	{{%/* /excerpt*/%}}
+
+{{%excerpt%}}
+Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod
+tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam,
+quis nostrud exercitation **ullamco** laboris nisi ut aliquip ex ea commodo
+consequat. Duis aute irure dolor in _reprehenderit in voluptate_
+cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non
+proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
+{{% /excerpt%}}
+
+
+
+{{%alert info%}}See re use example with [excerpt-include shortcode]({{%relref "shortcodes/excerpt-include.md"%}}){{%/alert%}}

package/docs/themes/docdock/exampleSite/content/shortcodes/expand.md

@@ -0,0 +1,41 @@
++++
+title = "expand"
+description = "Displays an expandable/collapsible section of text on your page"
++++
+
+The Expand shortcode displays an expandable/collapsible section of text on your page.
+Here is an example
+
+{{%expand%}}Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod
+tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam,
+quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo
+consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse
+cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non
+proident, sunt in culpa qui officia deserunt mollit anim id est laborum.{{%/expand%}}
+
+
+## Usage
+
+
+this shortcode takes exactly one optional parameter to define the text that appears next to the expand/collapse icon. (default is "Expand me...")
+
+	{{%/*expand "Is this docdock theme rocks ?" */%}}Yes !.{{%/* /expand*/%}}
+
+{{%expand "Is this docdock theme rocks ?" %}}Yes !{{% /expand%}}
+
+# Demo
+
+	{{%/*expand*/%}}Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod
+	tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam,
+	quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo
+	consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse
+	cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non
+	proident, sunt in culpa qui officia deserunt mollit anim id est laborum.{{%/* /expand*/%}}
+
+
+{{%expand%}}Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod
+tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam,
+quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo
+consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse
+cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non
+proident, sunt in culpa qui officia deserunt mollit anim id est laborum.{{% /expand%}}