[#6] provide documentation ghpages

Changed Navigation CSS a bit - looks better now
toolisticon · Jul 7, 2017 · 6ceb817 · 6ceb817
1 parent 8f92ae4
commit 6ceb817
Show file tree

Hide file tree

Showing 10 changed files with 96 additions and 93 deletions.
diff --git a/docs/_config.yml b/docs/_config.yml
@@ -1,18 +1,13 @@
-# Welcome to Jekyll!
-#
-# This config file is meant for settings that affect your whole blog, values
-# which you are expected to set up once and rarely edit after that. If you find
-# yourself editing this file very often, consider using Jekyll's data files
-# feature for the data you need to update frequently.
-#
-# For technical reasons, this file is *NOT* reloaded automatically when you use
-# 'bundle exec jekyll serve'. If you change this file, please restart the server process.
-
-# Site settings
-# These are used to personalize your new site. If you look in the HTML files,
-# you will see them accessed via {{ site.title }}, {{ site.email }}, and so on.
-# You can create any custom variable you would like, and they will be accessible
-# in the templates via {{ site.myvariable }}.
+source: .
+defaults:
+  -
+    scope:
+      path: "" # an empty string here means all files in the project
+    values:
+      layout: "post"
+      order: 100
+
+
 title: Java Annotation Processor Toolkit
 repository: "holisticon/annotation-processor-toolkit"
 email: [email protected]
@@ -24,18 +19,15 @@ github_username:  holisticon
 
 # Build settings
 markdown: kramdown
+
+kramdown:
+  input: GFM
+  hard_wrap: false
+
 theme: jekyll-theme-architect
 gems:
   - jekyll-feed
 
-# Exclude from processing.
-# The following items will not be processed, by default. Create a custom list
-# to override the default setting.
-# exclude:
-#   - Gemfile
-#   - Gemfile.lock
-#   - node_modules
-#   - vendor/bundle/
-#   - vendor/cache/
-#   - vendor/gems/
-#   - vendor/ruby/
+
+tz: Europe/Berlin
+
diff --git a/docs/_includes/navigation.html b/docs/_includes/navigation.html
@@ -1,37 +1,70 @@
 <div id="navigation">
 
     <div class="container">
-            {% assign pages_by_dir = (site.html_pages | group_by:"dir" %}
-            {% assign rootpages = (site.html_pages | where:"dir", "/" | sort:"order" ) %}
 
-            <ul>
-                {% for p in rootpages %}
+        {% assign pages_by_dir = (site.html_pages | group_by:"dir" %}
+        {% assign rootpages = (site.html_pages | where:"dir", "/" | sort:"order" ) %}
 
-                    {% if p.used_in_navigation != null && p.used_in_navigation == true %}
-                        {% assign menu_name = p.menu_name %}
-                        {% if menu_name == null %}
-                            {% assign menu_name = p.title %}
+        <ul>
+            {% for p in rootpages %}
+
+                {% if p.used_in_navigation != null && p.used_in_navigation == true %}
+                    {% assign menu_name = p.menu_name %}
+
+                    {% if menu_name == null %}
+                        {% assign menu_name = p.title %}
+                    {% endif %}
+
+                    {% assign subpageDirectory = (p.url | remove_first:'.html' | remove_first:'/' | prepend:'/' | append:'/') %}
+                    {% assign subpages = site.html_pages | where:"dir", subpageDirectory | sort:"order" %}
+
+                    {% if p.isSection == false %}
+
+                        {% if p.isIndex == true %}
+                            <li><a {% if page.url == p.url || relative_url  %} class="current"{% endif %} href="{{ p.url || relative_url}}">{{ menu_name }}</a>
+                        {% else %}
+                            <li><a {% if page.url contains subpageDirectory %} class="current"{% endif %} href="{{ p.url || relative_url}}">{{ menu_name }}</a>
                         {% endif %}
 
-                        <li><a href="{{ p.url || relative_url}}">{{ menu_name }}</a>
 
+                    {% else %}
+
+                        <li><a {% if page.url contains subpageDirectory %} class="current"{% endif %} href="#">{{ menu_name }}</a>
+
+                            {% if p.isSection == true and subpages != empty %}
                             <ul>
-                                <a href="#"><li>Tag 1</li></a>
-                                <a href="#"><li>Tag 2</li></a>
-                                <a href="#"><li>Tag 3</li></a>
-                                <a href="#"><li>Tag 4</li></a>
-                                <a href="#"><li>Tag 5</li></a>
+
+                                {% for p2 in subpages %}
+                                {% assign p2menu_name = p2.menu_name %}
+                                {% if p2menu_name == null %}
+                                {% assign p2menu_name = p2.title %}
+                                {% endif %}
+
+                                <a href="{{ p2.url || relative_url}}">
+                                    <li>{{p2menu_name}}</li>
+                                </a>
+                                {% endfor %}
                             </ul>
+                            {% endif %}
 
                         </li>
+
                     {% endif %}
+                {% endif %}
 
-                {% endfor %}
+            {% endfor %}
 
-                <li><a href="{{ '/assets/javadoc/0.4.1-SNAPSHOT/index.html' | relative_url }}">API</a></li>
+            <li>
+                <a href="#">API</a>
+                <ul>
+                    <a href="{{ '/assets/javadoc/0.4.1-SNAPSHOT/index.html' | relative_url }}">
+                        <li>0.4.1-SNAPSHOT</li>
+                    </a>
+                </ul>
+            </li>
 
 
-            </ul>
+        </ul>
 
 
     </div>

diff --git a/docs/_posts/2017-07-05-welcome-to-jekyll.markdown b/docs/_posts/2017-07-05-welcome-to-jekyll.markdown
diff --git a/docs/about.md b/docs/about.md
diff --git a/docs/assets/css/custom.css b/docs/assets/css/custom.css
@@ -1,5 +1,9 @@
----
----
+-
+-
+-
+-
+-
+-
 
 header {
     padding-bottom: 2.5em;
@@ -50,8 +54,6 @@ header h2 {
     color: #fff;
 }
 
-
-
 #navigation .container ul li {
     float: left;
     margin: 0 0 0 0;
@@ -145,6 +147,7 @@ header h2 {
     -o-transition: all .5s ease-in-out;
     -ms-transition: all .5s ease-in-out;
     transition: all .5s ease-in-out;
+    white-space: nowrap;
     z-index: 3;
 }
 
@@ -154,6 +157,10 @@ header h2 {
     background-color: #fff;
 }
 
+#navigation .container ul a.current {
+    color: #9ddcff;
+}
+
 #navigation .container ul ul li.all {
     font-size: 12px;
     border-bottom: none;
@@ -165,4 +172,3 @@ header h2 {
     color: #fff;
 }
 
-
diff --git a/docs/documentation.md → docs/documentation.html b/docs/documentation.md → docs/documentation.html
diff --git a/docs/documentation/aboutAnnotationProcessors.md b/docs/documentation/aboutAnnotationProcessors.md
@@ -0,0 +1,6 @@
+---
+layout: default
+used_in_navigation: true
+menu_name: About Annotation Processors
+order: 1
+---
diff --git a/docs/documentation/gettingStarted.md b/docs/documentation/gettingStarted.md
@@ -0,0 +1,6 @@
+---
+layout: default
+used_in_navigation: true
+menu_name: Getting Started
+order: 2
+---
diff --git a/docs/examples.md → docs/examples.html b/docs/examples.md → docs/examples.html
diff --git a/docs/index.md b/docs/index.md
@@ -2,6 +2,8 @@
 layout: default
 used_in_navigation: true
 menu_name: Home
+isSection: false
+isIndex: true
 order: 1
 ---
 
@@ -18,9 +20,10 @@ Code or resource generation with annotations can also be very useful.
 Sadly it's quite uncomfortable to develop and test annotation processors.
 First problem is that you have to cope with both both java compile time and run time model, which can be very tricky at the beginning.
 Another problem is that the tools offered by the JDK only offer some basic support for development.
+
 This project supports you by offering utilities that allow you to develop annotation processors in a more comfortable way.
-It also reduces the complexity of handling compile time and run time model by shading common pitfalls behind it's api.'
-Additionally it introduces a common approach how those annotation processors can be tested.
+It also reduces the complexity of handling compile time and run time model by shading common pitfalls behind it's api.
+Additionally it introduces a common approach for testing your annotation processors.
 
 # Features
 - provides support for Class conversion from runtime to compile time model (Class / FQN to Element and TypeMirror)