codefresh 0.78.2

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

@@ -0,0 +1,50 @@
++++
+title = "DocDock Theme for Hugo"
+description = ""
++++
+
+# Hugo docDock theme
+[Hugo-theme-docdock {{%icon fa-github%}}](https://github.com/vjeantet/hugo-theme-docdock) is a theme for Hugo, a fast and modern static website engine written in Go. Hugo is often used for blogs, **this theme is fully designed for documentation.**
+
+This theme is a partial porting of the [Learn theme of matcornic {{%icon fa-github%}}](https://github.com/matcornic/hugo-theme-learn). and its default style "flex" comes from [facette.io](https://github.com/facette)'s documentation.
+
+{{%panel%}}docDock works with a "page tree structure" to organize content : All contents are pages, which belong to other pages. [read more about this]({{%relref "content-organisation/_index.md"%}}) {{%/panel%}}
+
+## Main features
+
+* [Automatic Search]({{%relref "search/_index.md" %}})
+* **Unlimited menu levels**
+* [Generate RevealJS presentation]({{%relref "page-slide.md"%}}) from markdown (embededed or fullscreen page)
+* Automatic next/prev buttons to navigate through menu entries
+* [Image resizing, shadow...]({{%relref "create-page/page-images.md" %}})
+* [Attachments files]({{%relref "shortcodes/attachments.md" %}})
+* [List child pages]({{%relref "shortcodes/children/_index.md" %}})
+* [Excerpt]({{%relref "shortcodes/excerpt.md"%}}) ! Include segment of content from one page in another
+* [Mermaid diagram]({{%relref "shortcodes/mermaid.md" %}}) (flowchart, sequence, gantt)
+* [Icons]({{%relref "shortcodes/icon.md" %}}), [Buttons]({{%relref "shortcodes/button.md" %}}), [Alerts]({{%relref "shortcodes/alert.md" %}}), [Panels]({{%relref "shortcodes/panel.md" %}}), [Tip/Note/Info/Warning boxes]({{%relref "shortcodes/notice.md" %}}), [Expand]({{%relref "shortcodes/expand.md" %}})
+* [customizable look and feel]({{%relref "content-organisation/customize-style/_index.md"%}}), [theme style]({{%relref "content-organisation/customize-style/themestyle.md"%}}), [theme variants]({{%relref "content-organisation/customize-style/theme-variants.md"%}})
+
+
+
+Style "Flex" (default)
+
+![](style-flex.png?classes=border,shadow)
+
+Style "Original"
+
+![](style-original.png?classes=border,shadow)
+
+## Contribute to this documentation
+Feel free to update this content, just click the **Edit this page** link displayed on top right of each page, and pullrequest it
+{{%alert%}}Your modification will be deployed automatically when merged.{{%/alert%}}
+
+
+## Documentation website
+This current documentation has been statically generated with Hugo with a simple command : `hugo -t docdock` -- source code is [available here at GitHub {{%icon fa-github%}}](https://github.com/vjeantet/hugo-theme-docDock)
+
+{{% panel theme="success" header="Automated deployments" footer="Netlify builds, deploys, and hosts  frontends." %}}
+Automatically published and hosted thanks to [Netlify](https://www.netlify.com/).
+
+Read more about [Automated HUGO deployments with Netlify](https://www.netlify.com/blog/2015/07/30/hosting-hugo-on-netlifyinsanely-fast-deploys/)
+{{% /panel %}}
+

package/docs/themes/docdock/exampleSite/content/content-organisation/_index.md

@@ -0,0 +1,138 @@
++++
+title = "Content Organisation"
+description = ""
+weight = 20
++++
+
+With **Hugo**, pages are the core of your site. Organize your site like any other Hugo project. **Magic occurs with the nested sections implemention done in v0.22 of hugo (congrats @bep)**.
+
+With docdock, **Each content page composes the menu**, they shape the structure of your website.
+
+To link pages to each other, place them in a folders hierarchy
+
+```
+content
+├── level-one
+│   ├── level-two
+│   │   ├── level-three
+│   │   │   ├── level-four
+│   │   │   │   ├── _index.md
+│   │   │   │   ├── page-4-a.md
+│   │   │   │   ├── page-4-b.md
+│   │   │   │   └── page-4-c.md
+│   │   │   ├── _index.md
+│   │   │   ├── page-3-a.md
+│   │   │   ├── page-3-b.md
+│   │   │   └── page-3-c.md
+│   │   ├── _index.md
+│   │   ├── page-2-a.md
+│   │   ├── page-2-b.md
+│   │   └── page-2-c.md
+│   ├── _index.md
+│   ├── page-1-a.md
+│   ├── page-1-b.md
+│   └── page-1-c.md
+├── _index.md
+└── page-top.md
+```
+
+
+{{%alert info %}} **_index.md** is required in each folder, it's your "folder home page"{{%/alert%}}
+
+### Add header to a menu entry
+
+in the page frontmatter, add a `head` param to insert any HTML code before the menu entry:
+
+example to display a "Hello"
+
+	+++
+	title = "Github repo"
+	head ="<label>Hello</label> "
+	+++
+
+
+
+### Add icon to a menu entry
+
+in the page frontmatter, add a `pre` param to insert any HTML code before the menu label:
+
+example to display a github icon 
+
+	+++
+	title = "Github repo"
+	pre ="<i class='fa fa-github'></i> "
+	+++
+
+![dsf](/menu-entry-icon.png?height=40px&classes=shadow)
+
+<!-- ### Customize menu entry label
+
+Add a `name` param next to `[menu.main]`
+
+	+++
+	[menu.main]
+	parent = ""
+	identifier = "repo"
+	pre ="<i class='fa fa-github'></i> "
+	name = "Github repo"
+	+++ -->
+
+<!-- ### Create a page redirector
+Add a `url` param next to `[menu.main]`
+
+	+++
+	[menu.main]
+	parent = "page"
+	identifier = "page-images"
+	weight = 23
+	url = "/shortcode/image/"
+	+++
+
+{{%alert info%}}Look at the menu "Create Page/About images" which redirects to "Shortcodes/image{{%/alert%}}
+ -->
+### Order sibling menu/page entries
+
+in your frontmatter add `weight` param with a number to order.
+
+	+++
+	title="My page"
+	weight = 4
+	+++
+
+{{%info%}}add `ordersectionsby = "title"` in your config.toml to order menu entries by title{{%/info%}}
+
+
+### Hide a menu entry
+
+in your frontmatter add `hidden=true` param.
+
+	+++
+	title="My page"
+	hidden = true
+	+++
+
+
+### Unfolded menu entry by default
+
+One or more menuentries can be displayed unfolded by default. (like the "Getting start" menu entry  in this website)
+
+in your frontmatter add `alwaysopen=true` param.
+example :
+
+```
+title = "Getting start"
+description = ""
+weight = 1
+alwaysopen = true
+```
+
+### Folder structure and file name
+
+Content organization **is** your `content` folder structure.
+
+### Homepage
+
+Find out how to [customize homepage]({{%relref "homepage.md"%}}) 
+
+
+

package/docs/themes/docdock/exampleSite/content/content-organisation/customize-style/_index.md

@@ -0,0 +1,66 @@
++++
+title = "Customize website look and feel"
+Weight=3
++++
+
+You can change the style and behavior of the theme without touching it.
+
+* inject your own html,  css or js into the page
+* overide existing css or js with your own files
+
+{{%notice note %}}
+No needs to copy the entire theme to customize some parts 
+Bellow are solutions to avoid copying the entire theme into your own codebase.
+{{%/notice%}}
+
+## Add custom CSS and JS or HTML into the \<head\> part of each page :
+
+Create a custom header partial `layouts/partials/custom-head.html` 
+
+> * content/
+> * layouts/
+>   * partials/
+>      * custom-head.html
+
+write your own content like (an example from @nzbart):
+```html
+<link rel="stylesheet" href="/css/custom.css">
+<script src="/js/custom.js"></script>
+```
+
+Then overrode the style your want to change in `static/css/custom.css` (in this case, to avoid altering the casing of titles):
+```css
+h2 {
+    text-transform: none;
+}
+```
+
+And executed some additional JavaScript from `static/js/custom.js` (note that jQuery is already loaded by the theme):
+```javascript
+function tweakPage() {
+    // make some changes here
+}
+
+$(tweakPage)
+```
+
+
+now feel free to add the JS, CSS, HTML code you want :)
+
+## Add custom HTML at the end of the body part of each page :
+
+Create a `custom-footer.html` into a `layouts/partials` folder next to the content folder
+
+> * content/
+> * layouts/
+>   * partials/
+>      * custom-footer.html
+
+now feel free to add the JS, CSS, HTML code you want :)
+
+## Overide existing CSS or JS
+
+Create the matching file in your static folder, hugo will use yours instead of the theme's one.
+Example : 
+
+create a theme.css and place it into `static/css/` to fully overide docdock's theme.css

package/docs/themes/docdock/exampleSite/content/content-organisation/customize-style/disable.md

@@ -0,0 +1,24 @@
++++
+title = "Disable features"
++++
+
+You can disable feature in docdock by changing some params in `config.toml`
+
+
+## hide Next / Prev Chevrons
+```
+[params]
+disableNavChevron = true
+```
+
+## hide Search box in side menu
+```
+[params]
+disableSearch = true
+```
+
+## hide the {{%icon fa-home%}} icon in side bar
+```
+[params]
+disableHomeIcon = true
+```

package/docs/themes/docdock/exampleSite/content/content-organisation/customize-style/theme-variants.md

@@ -0,0 +1,35 @@
++++
+title = "Theme variants"
+description = "change theme style/colors"
++++
+
+In site configuration file, you can set a variant name of this theme to load a specific css, with different color specifications.
+
+add a param `themeVariant = "VARIANT_NAME"` in the `[params]` part of config.toml file.
+
+{{%info%}}Available variants change only colors at this moment{{%/info%}}
+
+
+## Variant "gray"
+```
+[params]
+themeVariant = "gray"
+```
+
+![green docdock](/variant-gray.png)
+
+## Variant "gold"
+```
+[params]
+themeVariant = "gold"
+```
+
+![gold docdock](/variant-gold.png)
+
+## Variant "green"
+```
+[params]
+themeVariant = "green"`
+```
+
+![green docdock](/variant-green.png)

package/docs/themes/docdock/exampleSite/content/content-organisation/customize-style/themestyle.md

@@ -0,0 +1,25 @@
++++
+title = "Theme styles"
+description = "change theme style"
++++
+
+In site configuration file, you can set a subtheme name of this theme to load a specific css.
+
+add a param `themeStyle = "STYLE_NAME"` in the `[params]` part of config.toml file.
+
+
+## Style "original"
+```
+[params]
+themeStyle = "original"
+```
+
+![green docdock](/variant-gray.png)
+
+## Style "flex" (work in progress)
+```
+[params]
+themeStyle = "flex"
+```
+
+![flex](/style-flex.png)

package/docs/themes/docdock/exampleSite/content/content-organisation/extramenu.md

@@ -0,0 +1,28 @@
++++
+title = "Extra menu entries"
+date = "2017-04-29T18:36:24+02:00"
+Weight=2
++++
+
+You can define additional menu entries in the navigation menu without any link to content.
+
+Edit the website configuration `config.toml` and add a `[[menu.shortcuts]]` entry for each link your want to add.
+
+
+Example from the current website, **note the `pre` param** which allows you to insert HTML code and used here to separate content's menu from this "static" menu 
+
+	[[menu.shortcuts]]
+	pre = "<h3>More</h3>"
+	name = "<i class='fa fa-github'></i> Github repo"
+	identifier = "ds"
+	url = "https://github.com/vjeantet/hugo-theme-docdock"
+	weight = 1
+
+	[[menu.shortcuts]]
+	name = "<i class='fa fa-bookmark'></i> Hugo Documentation"
+	identifier = "hugodoc"
+	url = "https://gohugo.io/"
+	weight = 2
+
+
+[{{%icon circle-arrow-right%}} Read more about hugo and menu here](https://gohugo.io/extras/menus/)

package/docs/themes/docdock/exampleSite/content/content-organisation/logo.md

@@ -0,0 +1,12 @@
++++
+title = "Logo placeholder"
+description = ""
+date = "2017-04-24T18:36:24+02:00"
+Weight=1
++++
+
+Create a `_header.md` page in content folder. Its content is what you get in the logo placeholder (top left of the screen).
+
+{{%alert info%}}**Tip :** you can add a image, a combobox with links to other documentation....{{%/alert%}}
+
+{{%alert info%}}**Tip 2 :** look at [ extra static menu]({{%relref "extramenu.md"%}}) if you want to add links to other website in this sidebar{{%/alert%}}

package/docs/themes/docdock/exampleSite/content/create-page/_index.md

@@ -0,0 +1,54 @@
++++
+title = "Create Page"
+description = ""
+date = "2017-04-24T18:36:24+02:00"
+creatordisplayname = "Valere JEANTET"
+creatoremail = "valere.jeantet@gmail.com"
+lastmodifierdisplayname = "Valere JEANTET"
+lastmodifieremail = "valere.jeantet@gmail.com"
+tags = ["tag1","tag2"]
+weight = 10
+pre ="<i class='fa fa-edit' ></i> "
+
++++
+
+
+Hugo-theme-docdock defines two types of pages. _Default_ and _Slide_.
+
+* **Default** is the common page like the current one you are reading.
+* **Slide** is a page that use the full screen to display its markdown content as a [reveals.js presentation](http://lab.hakim.se/reveal-js/).
+* **HomePage** is a special content that will be displayed as home page content.
+
+To tell Hugo-theme-docdock to consider a page as a slide, just add a `type="slide"`in then frontmatter of your file. [{{%icon circle-arrow-right%}}read more on page as slide]({{%relref "page-slide.md"%}})
+
+
+Hugo-theme-docdock provides archetypes to help you create this kind of pages.
+
+
+## Front Matter
+Each Hugo page has to define a Front Matter in yaml, toml or json.
+
+Hugo-theme-docdock uses the following parameters on top of the existing ones :
+
+	+++
+	# Type of content, set "slide" to display it fullscreen with reveal.js
+	type="page"
+
+	# Creator's Display name
+	creatordisplayname = "Valere JEANTET"
+	# Creator's Email
+	creatoremail = "valere.jeantet@gmail.com"
+	# LastModifier's Display name
+	lastmodifierdisplayname = "Valere JEANTET"
+	# LastModifier's Email
+	lastmodifieremail = "valere.jeantet@gmail.com"
+	+++
+
+
+## Ordering
+
+Hugo provides a flexible way to handle order for your pages.
+
+The simplest way is to use `weight` parameter in the front matter of your page. 
+
+[{{%icon circle-arrow-right%}}Read more on content organization]({{%relref "content-organisation/_index.md"%}})

package/docs/themes/docdock/exampleSite/content/create-page/homepage.md

@@ -0,0 +1,8 @@
++++
+title = "Home page"
+description = ""
+date = "2017-04-28T18:36:24+02:00"
+tags = ["tag1","tag2"]
++++
+
+To tell Hugo-theme-docdock to consider a page as homepage's content, just create a content file named `_index.md` in content folder.

package/docs/themes/docdock/exampleSite/content/create-page/myslide.md

@@ -0,0 +1,48 @@
++++
+title = "My Slide ! fullscreen"
+date = "2017-04-24T18:36:24+02:00"
+type="slide"
+hidden=true
+
+theme = "league"
+[revealOptions]
+transition= 'concave'
+controls= true
+progress= true
+history= false
+center= true
++++
+
+# In the morning
+
+___
+
+## Getting up
+
+- Turn off alarm
+- Get out of bed
+
+___
+
+## Breakfast
+
+- Eat eggs
+- Drink coffee
+
+---
+
+# In the evening
+
+___
+
+## Dinner
+
+- Eat spaghetti
+- Drink wine
+
+___
+
+## Going to sleep
+
+- Get in bed
+- Count sheep

package/docs/themes/docdock/exampleSite/content/create-page/page-images.md

@@ -0,0 +1,28 @@
++++
+title = "About images"
+date = "2017-04-24T18:36:24+02:00"
++++
+
+Images have a similar syntax to links but include a preceding exclamation point.
+
+	![agence](https://github.com/vjeantet/vjeantet.fr/raw/master/static/images/sgthon/C.jpg)
+
+![agence](https://github.com/vjeantet/vjeantet.fr/raw/master/static/images/sgthon/C.jpg)
+
+## Resizing image
+
+Add HTTP parameters `width` and/or `height` to the link image to resize the image. Values are CSS values (default is `auto`).
+
+
+	![Hackathon](https://github.com/vjeantet/vjeantet.fr/raw/master/static/images/sgthon/C.jpg?height=80px)
+
+![agence](https://github.com/vjeantet/vjeantet.fr/raw/master/static/images/sgthon/C.jpg?height=80px)
+
+
+## Add CSS classes
+
+Add a HTTP `classes` parameter to the link image to add CSS classes. `shadow` and `border` are available but you could define other ones.
+
+	![s](https://github.com/vjeantet/vjeantet.fr/raw/master/static/images/sgthon/C.jpg?classes=border,shadow)
+
+![agence](https://github.com/vjeantet/vjeantet.fr/raw/master/static/images/sgthon/C.jpg?classes=border,shadow)

package/docs/themes/docdock/exampleSite/content/create-page/page-slide.md

@@ -0,0 +1,114 @@
++++
+title = "Present a Slide"
+description = ""
+date = "2017-04-24T18:36:24+02:00"
++++
+
+A basic md content page can be rendered as a reveal.js presentation full screen.
+
+{{%alert info%}}You can, also, **embed presentation in a page** as a small box, using the [revealjs]({{% relref "shortcodes/revealjs.md"%}}) shortcode in your md file.{{%/alert%}}
+
+
+## Formating
+Use your common Markdown syntax you use in Hugo, don't forget, you can put html tags too.
+
+{{%notice info %}} Special syntax (in html comment) is available for adding attributes to Markdown elements. This is useful for fragments, amongst other things.
+{{%/notice%}}
+
+Please read the [{{%icon book%}} doc from hakimel](https://github.com/hakimel/reveal.js/#instructions)
+
+
+## Options
+In the frontmatter of your page file, set **type** and **revealOptions** params
+
+Your content will be served as a fullscreen revealjs presentation and revealOptions will be used to ajust its behaviour.
+
+	+++
+	title = "Test slide"
+	type="slide"
+
+	theme = "league"
+	[revealOptions]
+	transition= 'concave'
+	controls= true
+	progress= true
+	history= true
+	center= true
+	+++
+
+[read more about reveal options here](https://github.com/hakimel/reveal.js/#configuration)
+
+
+## Slide Delimiters
+When creating the content for your slideshow presentation within content markdown file you need to be able to distinguish between one slide and the next. This is achieved very simply using a  convention within Markdown that indicates the start of each new slide.
+
+As both horizontal and vertical slides are supported by reveal.js each has it's own unique delimiter.
+
+To denote the start of a horizontal slide simply add the following delimiter in your Markdown:
+
+	---
+
+
+To denote the start of a vertical slide simply add the following delimiter in your Markdown:
+	
+	___
+
+By using a combination of horizontal and vertical slides you can customize the navigation within your slideshow presentation. Typically vertical slides are used to present information below a top-level horizontal slide.
+
+
+
+For example, a very simple slideshow presentation can be created as follows
+
+```
++++
+
+title = "test"
+date = "2017-04-24T18:36:24+02:00"
+type="slide"
+
+theme = "league"
+[revealOptions]
+transition= 'concave'
+controls= true
+progress= true
+history= true
+center= true
++++
+
+# In the morning
+
+___
+
+## Getting up
+
+- Turn off alarm
+- Get out of bed
+
+___
+
+## Breakfast
+
+- Eat eggs
+- Drink coffee
+
+---
+
+# In the evening
+
+___
+
+## Dinner
+
+- Eat spaghetti
+- Drink wine
+
+___
+
+## Going to sleep
+
+- Get in bed
+- Count sheep
+
+```
+
+[{{%icon expand%}}click here to view this page rendered]({{%relref "myslide.md"%}})

package/docs/themes/docdock/exampleSite/content/credits.md

@@ -0,0 +1,44 @@
++++
+title = "Credits"
+description = "contributors and packages used by hugo-theme-docdock"
++++
+
+
+## github contributors
+{{%ghcontributors "https://api.github.com/repos/vjeantet/hugo-theme-docdock/contributors?per_page=100" %}}
+
+### Other contribution
+<div class="ghContributors">
+
+<div>
+<img src="https://avatars2.githubusercontent.com/u/394382?v=3" class="inline" width="32" height="32" style="height: 32px;height: 32px;margin-bottom:.25em; vertical-align:middle; ">
+<label>@<a href="https://github.com/bep">bep</a></label>
+<span class="contributions">supports and advices</span>
+</div>
+
+<div>
+<img src="https://avatars1.githubusercontent.com/u/959400?s=200&v=4" class="inline" width="32" height="32" style="height: 32px;height: 32px;margin-bottom:.25em; vertical-align:middle; ">
+<label>@<a href="https://github.com/facette">facette.io</a></label>
+<span class="contributions">Flex style based on facette documentation theme, <br>Thanks to @vbatoufflet</span>
+</div>
+
+</div>
+
+
+
+## Packages and libraries
+* [Bootstrap](http://getbootstrap.com) - front-end framework
+* [mermaid](https://knsv.github.io/mermaid) - generation of diagram and flowchart from text in a similar manner as markdown
+* [font awesome](http://fontawesome.io/) - the iconic font and CSS framework
+* [jQuery](https://jquery.com) - The Write Less, Do More, JavaScript Library
+* [lunr](https://lunrjs.com) - Lunr enables you to provide a great search experience without the need for external, server-side, search services...
+* [JavaScript-autoComplete](https://github.com/Pixabay/JavaScript-autoComplete) - An extremely lightweight and powerful vanilla JavaScript completion suggester.
+* [clipboard.js](https://zenorocha.github.io/clipboard.js) - copy text to clipboard
+* [highlight.js](https://highlightjs.org) - Javascript syntax highlighter
+* [modernizr](https://modernizr.com) - A JavaScript toolkit that allows web developers to use new CSS3 and HTML5 features while maintaining a fine level of control over browsers that don't support
+* [reveal-js](http://lab.hakim.se/reveal-js) - The HTML Presentation Framework
+
+## Tooling
+
+* [Netlify](https://www.netlify.com) - Continuous deployement and hosting of this documentation
+* [Hugo](https://gohugo.io/) {{%icon "fa-smile-o"%}}