inid docs (#16)

* Update .gitignore file.

* Added couscous as bin tool.

* Init. docs and docs template.

* Fix doc template (lang='en').

.gitignore

@@ -1,4 +1,5 @@
 .idea/
+.couscous/
 
 composer.lock
 .phpunit.result.cache

couscous.yml

@@ -0,0 +1,66 @@
+# @see https://couscous.io/docs/configuration.html
+
+template:
+  # Name of the directory containing the website template (default is "website")
+  directory: docs/template/
+  # Or if you are using a remote template, you can set the Git URL
+  #url: https://github.com/CouscousPHP/Template-Light.git
+
+  # Name of the index file (default is "README.md")
+  index: docs/index.md
+
+# List of directories to include in the processing (by default it's empty, so all markdown files are parsed)
+# Paths are relative to the optional source path given when generating the website, repository root by default
+include:
+  - docs
+
+# List of directories to exclude from the processing (default contains "vendor" and "website")
+# Paths are relative to the optional include paths given when generating the website, repository root by default
+# The ".gitignore" file will also be read if it exists to exclude the directories in it
+exclude:
+  - vendor
+  #- website
+  #- some/dir
+
+scripts:
+# Scripts to execute before generating the website
+#before:
+#- cp bin/couscous.phar website/
+# Scripts to execute after generating the website
+#after:
+#- rm website/couscous.phar
+
+# Set this variable to use a Custom Domain
+# The content of this variable will be directly inserted into the CNAME file
+#cname: docs.yourdomain.com
+
+# Set the target branch in which to deploy the generated website
+branch: gh-pages
+
+
+# Base URL of the published website (no "/" at the end!)
+# You are advised to set and use this variable to write your links in the HTML layouts
+baseUrl: https://medicalmundi.github.io/oe-module-marketplace
+
+
+# Any variable you put in this file is also available in the Twig layouts:
+title: MedicalMundi - Modules Marketplace - Documentazione
+titleShort: Modules Marketplace
+subTitle: subtitle 'cool module'
+
+github:
+  user: medicalmundi
+  repo: oe-module-marketplace
+
+
+# The left menu bar
+menu:
+  sections:
+    developer-guide:
+      name: Developer Guide
+      items:
+        quick-start:
+          text: Quick start
+          # You can use relative urls
+          relativeUrl: developer-guide/quick-start.html
+

docs/developer-guide/quick-start.md

@@ -0,0 +1,6 @@
+# Quick start [WIP]
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Duis et magna at ante semper pulvinar sed nec dolor.
+Donec volutpat sodales sem id blandit. Nullam sed arcu elit. Etiam tempor sed urna eget egestas.
+Quisque mollis, urna gravida fermentum congue, felis leo bibendum justo, ac elementum ligula risus in purus.
+Phasellus vel sapien vehicula, hendrerit tellus eu, hendrerit magna.

docs/index.md

@@ -0,0 +1,7 @@
+
+# Index [WIP]
+
+Lorem ipsum dolor sit amet, consectetur adipiscing elit. Duis et magna at ante semper pulvinar sed nec dolor.
+Donec volutpat sodales sem id blandit. Nullam sed arcu elit. Etiam tempor sed urna eget egestas.
+Quisque mollis, urna gravida fermentum congue, felis leo bibendum justo, ac elementum ligula risus in purus.
+Phasellus vel sapien vehicula, hendrerit tellus eu, hendrerit magna.

docs/template/css/highlight.tomorrow-night.css

@@ -0,0 +1,45 @@
+/* Tomorrow Night Theme */
+/* http://jmblog.github.com/color-themes-for-google-code-highlightjs */
+/* Original theme - https://github.com/chriskempson/tomorrow-theme */
+/* http://jmblog.github.com/color-themes-for-google-code-highlightjs */
+.tomorrow-comment, pre .comment, pre .title {
+  color: #969896;
+}
+
+.tomorrow-red, pre .variable, pre .attribute, pre .tag, pre .regexp, pre .ruby .constant, pre .xml .tag .title, pre .xml .pi, pre .xml .doctype, pre .html .doctype, pre .css .id, pre .css .class, pre .css .pseudo {
+  color: #cc6666;
+}
+
+.tomorrow-orange, pre .number, pre .preprocessor, pre .built_in, pre .literal, pre .params, pre .constant {
+  color: #de935f;
+}
+
+.tomorrow-yellow, pre .class, pre .ruby .class .title, pre .css .rules .attribute {
+  color: #f0c674;
+}
+
+.tomorrow-green, pre .string, pre .value, pre .inheritance, pre .header, pre .ruby .symbol, pre .xml .cdata {
+  color: #b5bd68;
+}
+
+.tomorrow-aqua, pre .css .hexcolor {
+  color: #8abeb7;
+}
+
+.tomorrow-blue, pre .function, pre .python .decorator, pre .python .title, pre .ruby .function .title, pre .ruby .title .keyword, pre .perl .sub, pre .javascript .title, pre .coffeescript .title {
+  color: #81a2be;
+}
+
+.tomorrow-purple, pre .keyword, pre .javascript .function {
+  color: #b294bb;
+}
+
+pre code {
+  display: block;
+  background: #1d1f21;
+  color: #c5c8c6;
+  font-family: Menlo, Monaco, Consolas, monospace;
+  line-height: 1.5;
+  border: 1px solid #ccc;
+  padding: 10px;
+}

docs/template/css/main.css

@@ -0,0 +1,106 @@
+body {
+    font-size: 20px;
+}
+
+main {
+    margin-top: 90px;
+}
+
+section {
+    margin-bottom: 50px;
+}
+
+h1, h2, h3, h4 {
+    color: #34b891;
+}
+h3 {
+    font-size: 23px;
+}
+
+a, a:hover {
+    color: #34b891;
+}
+
+li {
+    margin-bottom: 3px;
+}
+
+img {
+    max-width: 100%;
+}
+
+header.navbar {
+    opacity: 0.9;
+}
+.navbar .navbar-brand {
+    font-size: 28px;
+    height: auto;
+    line-height: 50px;
+    margin-left: 20px;
+    color: #34b891;
+}
+.navbar a.navbar-brand:hover {
+    color: #34b891;
+}
+.navbar .navbar-brand small {
+    font-size: 18px;
+    font-weight: 300;
+    margin-left: 10px;
+    color: white;
+}
+
+.nav-pills>li.active>a, .nav-pills>li.active>a:hover, .nav-pills>li.active>a:focus {
+    background-color: #34b891;
+}
+
+@media (min-width: 768px) {
+    #sidebar {
+        position:absolute;
+    }
+}
+@media (max-width: 960px) {
+    body {
+        font-size: 17px;
+    }
+    pre {
+        font-size: 12px;
+    }
+}
+
+.page-header {
+    margin-top: 0;
+}
+
+#sidebar .github-star {
+    margin-top: 20px;
+    margin-left: 50px;
+}
+
+#sidebar .text-muted {
+    color: #859AAF;
+}
+
+pre {
+    padding: 0;
+    border-color: #3D5166;
+    background-color: #1D2B3A;
+    border-radius: 4px;
+    margin: 15px;
+}
+pre code {
+    border: none;
+    background-color: #1D2B3A;
+}
+
+code {
+    font-size: 85%;
+    padding: 4px 4px 1px;
+    margin: 0 4px;
+    border-radius: 3px;
+    color: #c5c8c6;
+    border: solid 1px #3D5166;
+    background-color: #1D2B3A;
+    white-space: pre-wrap;
+    white-space: -moz-pre-wrap;
+    word-wrap: break-word;
+}

docs/template/default.twig

@@ -0,0 +1,84 @@
+<!DOCTYPE html>
+<html lang="en">
+    <head>
+        <meta name="robots" content="noindex">
+        <meta charset="utf-8">
+        <meta name="viewport" content="width=device-width, initial-scale=1">
+        <link rel="icon" href="{{ baseUrl }}/favicon.svg" type="image/svg+xml" sizes="any">
+
+
+        <title>{{ title }}</title>
+
+        <link rel="stylesheet" href="{{ baseUrl }}/css/bootstrap.min.css">
+        <link rel="stylesheet" href="{{ baseUrl }}/css/font-awesome.min.css">
+        <link rel="stylesheet" href="{{ baseUrl }}/css/highlight.tomorrow-night.css">
+        <link rel="stylesheet" href="{{ baseUrl }}/css/main.css">
+    </head>
+    <body>
+
+        <header class="navbar navbar-default navbar-fixed-top">
+
+            <a class="navbar-brand" href="{{ baseUrl }}/">
+                {{ titleShort|default('The title') }}
+                <small class="hidden-xs hidden-sm">
+                    {{ subTitle|default('This is the default subtitle!')|raw }}
+                </small>
+            </a>
+
+            {% if github is defined %}
+
+            <a href="https://github.com/{{ github.user }}/{{ github.repo }}">
+                <img style="position: absolute; top: 0; right: 0; border: 0;" src="https://camo.githubusercontent.com/38ef81f8aca64bb9a64448d0d70f1308ef5341ab/68747470733a2f2f73332e616d617a6f6e6177732e636f6d2f6769746875622f726962626f6e732f666f726b6d655f72696768745f6461726b626c75655f3132313632312e706e67" alt="Fork me on GitHub" data-canonical-src="https://s3.amazonaws.com/github/ribbons/forkme_right_darkblue_121621.png">
+
+            </a>
+            {% endif %}
+
+        </header>
+
+        <main class="{{ menu ? 'container-fluid' : 'container' }}">
+            <div class="row">
+
+                {% if menu is defined %}
+
+                    <nav id="sidebar" class="col-sm-3 col-lg-2" role="navigation">
+
+                        {% for section in menu.sections %}
+                            <p class="text-muted">
+                                {{ section.name }}
+                            </p>
+
+                            <ul class="nav nav-pills nav-stacked">
+                                {% for itemId, item in section.items %}
+                                    <li class="{{ itemId == currentMenu ? 'active' }}">
+                                        <a href="{{ item.absoluteUrl|default(baseUrl ~ '/' ~ item.relativeUrl) }}">
+                                            {{ item.text|raw }}
+                                        </a>
+                                    </li>
+                                {% endfor %}
+                            </ul>
+                        {% endfor %}
+
+                    </nav>
+
+                {% endif %}
+
+                <section class="{{ menu ? 'col-sm-offset-3 col-lg-offset-2 col-sm-9 col-lg-10' : 'col-sm-12' }}">
+                    {{ content|raw }}
+                </section>
+
+            </div>
+        </main>
+
+        <script src="//code.jquery.com/jquery-1.11.0.min.js"></script>
+        <script src="//netdna.bootstrapcdn.com/bootstrap/3.1.1/js/bootstrap.min.js"></script>
+        <script src="//yandex.st/highlightjs/7.5/highlight.min.js"></script>
+
+        <script>
+            $(function() {
+                $("section>h1").wrap('<div class="page-header" />');
+                // Syntax highlighting
+                hljs.initHighlightingOnLoad();
+            });
+        </script>
+    </body>
+</html>