refactor: clean up and prepare for release 1.0.0

lakto · Sep 25, 2018 · f70f307 · f70f307
1 parent 1b9c68c
commit f70f307
Show file tree

Hide file tree

Showing 29 changed files with 83 additions and 311 deletions.
diff --git a/_config.yml b/_config.yml
@@ -3,10 +3,11 @@
 
 title: Dokumentado
 url: https://lakto.github.io/dokumentado
-version: v1.0.0-alpha
+version: v1.0.0
 baseurl:
 google_analytics_key:
 show_full_navigation: true
+template: https://code.getmdl.io/1.3.0/material.blue_grey-amber.min.css
 git:
   name: Github
   repository: Dokumentado
@@ -36,7 +37,7 @@ links:
 
 # Values for the jekyll-seo-tag gem (https://github.com/jekyll/jekyll-seo-tag)
 logo: assets/images/touch-icon.png
-description: Dokumentado is a landing page and documentation template for Jekyll, useful for GitHub pages.
+description: Documentation and landing page template for Jekyll, useful for GitHub pages.
 author:
   name: André Kilchenmann
   email: [email protected]

diff --git a/_docs/01-getting-started/configure.md b/_docs/01-getting-started/configure.md
@@ -0,0 +1,14 @@
+---
+title: Configuration
+category: Getting Started
+order: 2
+---
+
+You have to configure your page settings in the `_config.yml` file. It should be self-explained.
+
+### Structure
+The template has several folders and files, which are important. For the landing page you have to use the `index.html` file.
+
+The documentation files should be stored in `_docs` or in `_manual`. Each of the folder has a `_default.md` file template.
+
+Posts of the category "news" are stored in `_posts`. The files inside of this folder should start with the date of format 'yyyy-mm-dd' and followed by the title. 
diff --git a/_docs/01-getting-started/prerequisites.md b/_docs/01-getting-started/prerequisites.md
@@ -4,29 +4,22 @@ category: Getting Started
 order: 1
 ---
 
-We develop the Salsah app with Angular 6, especially with Angular-cli, which requires the following tools:
+You can use this template by fork it from [Github](https://github.com/lakto/dokumentado) or to pull it from there. It's built with [Jekyll](http://jekyllrb.com/) version 3.3.1, but should support newer versions as well.
 
+You have to be in the root directory of Dokumentado to install the dependencies as follow:
 
-### Node
-Install [Node](https://nodejs.org/en/download/) in version >=4 <=9. We recommend to use version 8.9.0.
+~~~bash
+$ bundle install
+~~~
 
-The easiest way to install node in the correct version is to use '[n](https://github.com/tj/n)'.
+Run `jekyll` commands through Bundler to ensure you're using the right versions:
 
+~~~bash
+$ bundle exec jekyll serve
+~~~
 
-### Yarn (instead of npm)
-By installing node, you get the node package manager (npm), which will be used for the app dependency management. But we recommend to use [yarn](https://yarnpkg.com/en/) instead of npm.
+To see the generated site, just visit `http://localhost:4000`.
 
-Install yarn by following the [instructions on their website](https://yarnpkg.com/en/docs/install).
 
-
-### Angular-cli
-To start the app or to create new components and services, you need [angular-cli](https://github.com/angular/angular-cli), which should be installed globally.
-
-`$ yarn global add @angular/cli`
-
-<!--
-If there are some permission issues, try to fix the writing rights in node with `sudo chown -R $(whoami) $(npm config get prefix)/{lib/node_modules,bin,share}` 
--->
-
-### [&rarr; Start the app]({{ site.baseurl }}/docs/01-getting-started/start/)
+### [&rarr; Start the app]({{ site.baseurl }}/docs/01-getting-started/configure/)
 
diff --git a/_docs/01-getting-started/start.md b/_docs/01-getting-started/start.md
diff --git a/_docs/02-developer-docs/coding.md b/_docs/02-developer-docs/coding.md
diff --git a/_docs/02-developer-docs/commit.md b/_docs/02-developer-docs/commit.md
diff --git a/_docs/02-developer-docs/structure.md b/_docs/02-developer-docs/structure.md
diff --git a/_features/01-data.md b/_features/01-data.md
diff --git a/_features/01.md b/_features/01.md
@@ -0,0 +1,5 @@
+---
+title: Simple template
+icon: thumb_up
+---
+Easy to use jekyll template to build landing pages and documentation on GitHub
diff --git a/_features/02-share.md b/_features/02-share.md
diff --git a/_features/02.md b/_features/02.md
@@ -0,0 +1,5 @@
+---
+title: Configurable
+icon: build
+---
+Generic template, which needs only a few configuration steps.
diff --git a/_features/03-search.md b/_features/03-search.md
diff --git a/_features/03.md b/_features/03.md
@@ -0,0 +1,5 @@
+---
+title: Customize
+icon: brush
+---
+It's built with [Material Design Lite](https://getmdl.io/) and can be customized with own css theme builder.
diff --git a/_features/04-history.md b/_features/04-history.md
diff --git a/_features/05_access.md b/_features/05_access.md
diff --git a/_features/06-web.md b/_features/06-web.md
diff --git a/_layouts/default.html b/_layouts/default.html
@@ -11,7 +11,7 @@
     <link rel="stylesheet" href="https://fonts.googleapis.com/icon?family=Material+Icons">
 
     <!-- getMDL layout-->
-    <link rel="stylesheet" href="https://code.getmdl.io/1.3.0/material.teal-amber.min.css">
+    <link rel="stylesheet" href="{{site.template}}">
     <script defer src="https://code.getmdl.io/1.3.0/material.min.js"></script>
 
     <!-- offline (developer) usage -->

diff --git a/_manual/01-first-steps/example.md b/_manual/01-first-steps/example.md
@@ -0,0 +1,6 @@
+---
+title: Example page
+category: Manual
+order: 1
+---
+This is just an example page in the manual
diff --git a/_manual/01-first-steps/project.md b/_manual/01-first-steps/project.md
diff --git a/_manual/01-first-steps/user.md b/_manual/01-first-steps/user.md
diff --git a/_posts/2018-03-28-pre-release.md b/_posts/2018-03-28-pre-release.md
diff --git a/_posts/2018-05-30-pre-release.md b/_posts/2018-05-30-pre-release.md
diff --git a/_posts/2018-06-30-release-1.6.0.md b/_posts/2018-06-30-release-1.6.0.md