feat(Hugo): switch to hugo (#13)

* build(hugo): switch to hugo setup and make it work

* chore(ignored folders): add empty archetypes and data folders

hugo folders that might be needed later

* feat(hugo-vamp): implement vamp theme and adjust content files to work with it

* refactor(static assets): move static assets to src directory and adjust gulpfile.js to accomodate

also removed some unused files

* build(gulp): correct styles order and add minification

* chore(static): remove dist files

* chore(static): remove more dist files

* chore(static): adjust gitignore for removed static folder

* build(gulp): copy js vendor files without concatenating

since we have http2 this should be preferred

* chore(src/scripts): remove unused scripts

* build(gulp): load all js files in src dir and uglify them

* build(gulp): add watch task and split gulp tasks into meaningful names

* build(gulp): split tasks into separate files, use gulpfile.js folder instead of file, remove unused

* chore(base-url): remove base-url file and gitignore it

this file is generated by the gulp task and changes when using a different environmen (e.g. gulp vs.
gulp build)

* chore(themes): remove unused theme and themes folder

* build(gulp): convert all styles to sass

* fix(config): correct baseUrl to make redirects work locally

* docs(readme): add copy of vamp repo readme

* docs(readme): make readme standard compliant

* docs(readme): add gulp step to install instructions

* feat(layouts/index.html): redirect start page to first main menu url

removed old custom start page

* perf(config): remove redirect on menu links by adding the complete url to main menu items

also moved tutorial to its own separate folder

* refactor(images): remove unused vamp images

missing menu item icon now, but that should be changed anyways

* build(gulp): add missing array for watch task

* chore(static): add static folder to prevent error on first gulp run

buildSearchIndex throws an error if the folder doesn't exist yet

* chore(static): actually add the .gitkeep file...

* docs(README.md): Add step to run npm install

* docs(readme): adjust installation instructions

use yarn, add periods to the end of sentences

* build(gulp): watch all sass files instead of just main files

* fix(config.toml): social twitter param defined correctly

* feat(layouts, styles): add flynt logo and brand colours

* fix(config.toml): add correct favicon url

* feat(styles): use more flynt grey/greens rather than vamp blues

* feat(styles): adjust base colors to greys from grey-blues

* fix(baseStyles): fix up any broken base styling, update highlight.js

* fix(components): remove un-needed styling, fix more base styles that we brought over

* fix(styles): update mobile menu styles

* build(gulp): add browsersync, add hugo to the gulp process

instead of using hugo server as an additional simultaneous process, now this all happens in a single
process

* build(docker): add Dockerfile

build and run production version with this

* chore(Icon files): remove from repo and gitignore them

* docs(readme): correct instructions for browsersync setup

* fix(config): use localhost:1313 as dev base url

* build(gulp): browser sync watch static folder only

Author: Doğa Gürdal

.dockerignore

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

.gitignore

@@ -1,4 +1,46 @@
-_book
+*.css.map
+static
+!static/.gitkeep
+.idea
+public
 node_modules
-npm-debug.log
-docs/styles/**/*.css.map
+layouts/partials/base-url.html
+
+# Compiled source #
+###################
+*.com
+*.class
+*.dll
+*.exe
+*.o
+*.so
+
+# Packages #
+############
+# it's better to unpack these files and commit the raw source
+# git has its own built in compression methods
+*.7z
+*.dmg
+*.gz
+*.iso
+*.jar
+*.rar
+*.tar
+*.zip
+
+# Logs and databases #
+######################
+*.log
+*.sql
+*.sqlite
+
+# OS generated files #
+######################
+.DS_Store
+.DS_Store?
+._*
+.Spotlight-V100
+.Trashes
+ehthumbs.db
+Thumbs.db
+Icon  

Dockerfile

@@ -0,0 +1,54 @@
+FROM ubuntu:16.04
+
+ENV DEBIAN_FRONTEND noninteractive
+
+RUN apt-get update \
+  && apt-get install -y --no-install-recommends \
+    curl \
+    ca-certificates \
+    git \
+  && rm -rf /var/lib/apt/lists/*
+
+RUN curl -sL https://deb.nodesource.com/setup_6.x | bash - \
+  && apt-get update \
+  && apt-get install -y --no-install-recommends nodejs \
+  && rm -rf /var/lib/apt/lists/*
+
+RUN curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | apt-key add - \
+  && echo "deb https://dl.yarnpkg.com/debian/ stable main" | tee /etc/apt/sources.list.d/yarn.list \
+  && apt-get update \
+  && apt-get install -y --no-install-recommends yarn \
+  && rm -rf /var/lib/apt/lists/*
+
+RUN apt-get -qq update \
+	&& apt-get -qq install -y --no-install-recommends python-pygments \
+    software-properties-common \
+    python-software-properties \
+	&& rm -rf /var/lib/apt/lists/*
+
+RUN add-apt-repository ppa:longsleep/golang-backports \
+  && apt-get update \
+  && apt-get install -y --no-install-recommends golang-go \
+  && rm -rf /var/lib/apt/lists/*
+
+ENV GOPATH /go
+ENV PATH $GOPATH/bin:/usr/local/go/bin:$PATH
+
+RUN apt-get update \
+  && apt-get install -y --no-install-recommends build-essential \
+  && rm -rf /var/lib/apt/lists/*
+
+RUN go get -u github.com/kardianos/govendor \
+  && govendor get github.com/spf13/hugo
+
+RUN cd /go/src/github.com/spf13/hugo \
+  && make install
+
+RUN mkdir /usr/share/src
+WORKDIR /usr/share/src
+
+# Expose default hugo port
+EXPOSE 1313
+
+# By default, serve site
+CMD yarn && yarn run build && yarn run buildIndex

README.md

@@ -1,13 +1,171 @@
-# What is Flynt?
+# flynt-documentation
+[![standard-readme compliant](https://img.shields.io/badge/readme%20style-standard-brightgreen.svg?style=flat-square)](https://github.com/RichardLitt/standard-readme)
 
-Flynt is a component based WordPress framework for development teams and their clients.
+> Source for the [Flynt Framework documentation](https://docs.flyntwp.com).
 
+## Table of Contents
 
-## Philosophy
-<!-- TODO: Write this section. -->
+- [Install](#install)
+- [Usage](#usage)
+  - [Adding menu items](#adding-menu-items)
+  - [Versioning](#versioning)
+  - [Adding Redirects for old content](#adding-redirects-for-old-content)
+- [Maintainers](#maintainers)
+- [Contribute](#contribute)
+- [License](#license)
 
-## Ecosystem
-<!-- TODO: Write this section. -->
+## Install
 
-## Resources / Next Steps
-<!-- TODO: Write this section. -->
+1. Clone this repo.
+
+        $ git clone https://github.com/bleech/flynt-docs.git
+
+2. Download Hugo from [http://gohugo.io](http://gohugo.io) or install using Homebrew:
+
+        $ brew update && brew install hugo
+
+3. Install npm packages using [yarn](https://yarnpkg.com/) (make sure yarn is installed on your system).
+
+        $ yarn
+
+4. Start the default gulp task to build and watch styles, scripts and assets. The site is served under `localhost:1313`.
+
+        $ gulp
+
+5. Add content under the `content/` tree.
+
+## Usage
+
+### Adding menu items
+#### Top menu item
+1. Go to the `config.toml` file
+2. Go to the `# Top Menu Items` comment
+3. Add a top menu item like this:
+
+```
+[[menu.main]]
+    name = "Top menu name"      
+    url = "/top/menu/subpage/"
+    identifier = "unique-identifier"
+    weight = 10
+```
+|Attribute  |Type   |Details                                            |
+|-----------|-------|-------------------------------------------------- |
+|name       |string |Name that will show up in the top menu.            |  
+|url        |string |Explicit url to wich the page should point to.     |
+|identifier |string |Should be **unique** for every item!               | 
+|weight     |int    |For the order of menu items, lower is more on top  |
+
+#### Side Menu item
+1. Go to the `config.toml` file
+2. Go to the `# Side Menu Items` comment
+3. Add a side menu item like this:
+
+```
+[[menu.main]]
+    name = "Side menu name"      
+    url = "/side/menu/subpage/"
+    parent = "parent-identifier"
+    identifier = "unique-sub-identifier"
+    weight = 10
+```
+|Attribute  |Type   |Details                                            |
+|-----------|-------|-------------------------------------------------- |
+|name       |string |Name that will show up in the side menu.           |
+|parent     |string |Identifier of the top menu item under wich this page resides|
+|url        |string |Explicit url to wich the page should point to.     |
+|identifier |string |Should be **unique** for every item!               | 
+|weight     |int    |For the order of menu items, lower is more on top  |
+
+#### Side submenu item
+1. Go to the page that should be added to the side menu in the `Content` folder.
+2. At the top of the page add this to the parameter:
+```
+menu:
+    main: 
+        name: "Side menu name"
+        parent: "unique-sub-identifier"
+        weight: 20
+```
+|Attribute  |Type   |Details                                            |
+|-----------|-------|-------------------------------------------------- |
+|name       |string |Name that will show up in the sub menu.           |
+|parent     |string |Identifier of the side menu item under wich this page resides|
+|weight     |int    |For the order of menu items, lower is more on top  |
+
+### Versioning
+1. Go to the pages where you want subversioning on.
+```
+-api
+--test1.md
+--test2.md
+```
+2. Create subfolders for every version, and put copies of the files in them. **Every version subfolder should start with the letter v and an integer (v1.0.0, v23.43.bla)**
+```
+-api
+--v1.0.0
+---test1.md
+---test2.md
+--v2.0.0
+---test1.md
+---test2.md
+```
+
+3. Add them to the sidemenu like you would do with a normal file. **Don't forget to give every page a unique id and different weight. Weight will determain position in the dropdown menu**
+
+
+##### Example:
+**api/v1.0.0/test1.md**
+```
+menu:
+    main: 
+        name: "Test01"
+        parent: "unique-sub-identifier"
+        identifier: 'test01-v1' #Different from v2.0.0
+        weight: 20 #Different from v2.0.0
+```
+**api/v2.0.0/test1/md**
+```
+menu:
+    main: 
+        name: "Test02"
+        parent: "unique-sub-identifier"
+        identifier: 'test01-v2' #Different from v1.0.0
+        weight: 30 #Different from v1.0.0
+```
+
+### Adding Redirects for old content
+
+This is done by adding the old URL (the one you want to redirect) as an alias to the new destination page.
+
+##### Example:
+```
+date: 2016-09-13T09:00:00+00:00
+title: Artifacts
+menu:
+    main:
+        parent: "Using Flynt"
+        weight: 10
+aliases:
+    - /using-flynt/
+```
+
+## Maintainers
+
+This project is maintained by [bleech](https://github.com/bleech).
+
+The main people in charge of this repo are:
+
+- [Dominik Tränklein](https://github.com/domtra)
+- [Doğa Gürdal](https://github.com/Qakulukiam)
+- [Michael Carruthers](https://github.com/emcarru)
+
+## Contribute
+
+To contribute, please use github [issues](https://github.com/flyntwp/flynt-docs/issues). Pull requests are accepted.
+
+If editing the README, please conform to the [standard-readme](https://github.com/RichardLitt/standard-readme) specification.
+
+## License
+
+MIT © [bleech](https://www.bleech.de)