doc theme

2017-09-08 19:13:41 -07:00
parent f2a9f8a938
commit cb861e72a9
300 changed files with 38823 additions and 0 deletions
@@ -0,0 +1,12 @@
+++
+title = "Getting start"
+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"%}}
@@ -0,0 +1,26 @@
+++
+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-->
+```
+theme = "docdock"
+```
+
+## Search index generation
+
+Add the follow line in the same `config.toml` file.
+
+```
+[outputs]
+home = [ "HTML", "RSS", "JSON"]
+```
+
+LUNRJS search index file will be generated on content changes.
+
+## 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.
@@ -0,0 +1,31 @@
+++
+title = "Installation"
+description = ""
+weight = 1
+++
+
+{{% alert theme="warning" %}}HUGO **v0.25** 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-->
+
+## Create Your Documentation
+
+Hugo provides a `new` command to create a new website.
+
+	$ hugo new site <new_website>
+
+## Install The Theme
+
+Install the **Hugo-theme-docdock** theme by following this 
+
+Switch into the themes directory and download the theme
+
+	$ cd themes
+	$ git clone https://github.com/vjeantet/hugo-theme-docdock.git docdock
+
+Alternatively, you can [{{%icon download%}} download the theme as .zip](https://github.com/vjeantet/hugo-theme-docdock/archive/master.zip) file and extract it in the themes directory
+
+## Basic Configuration
+
+[Follow instructions here]({{%relref "configuration.md"%}})