From 866e364dde76aa5df42548bf72d2f5c4d200535b Mon Sep 17 00:00:00 2001
From: Felix Mulder <felix.mulder@gmail.com>
Date: Tue, 24 Jan 2017 17:35:53 +0100
Subject: Document dottydoc capabilities, add anchored headers

---
 doc-tool/resources/_layouts/api-page.html  |  2 +-
 doc-tool/resources/_layouts/blog-page.html | 28 ++++++++++++++++
 doc-tool/resources/_layouts/blog.html      | 28 ----------------
 doc-tool/resources/_layouts/doc-page.html  |  2 +-
 doc-tool/resources/_layouts/doc.html       | 49 ----------------------------
 doc-tool/resources/_layouts/sidebar.html   | 49 ++++++++++++++++++++++++++++
 doc-tool/resources/css/dottydoc.css        | 51 +++++++++++++++++++++++++++++-
 7 files changed, 129 insertions(+), 80 deletions(-)
 create mode 100644 doc-tool/resources/_layouts/blog-page.html
 delete mode 100644 doc-tool/resources/_layouts/blog.html
 delete mode 100644 doc-tool/resources/_layouts/doc.html
 create mode 100644 doc-tool/resources/_layouts/sidebar.html

(limited to 'doc-tool/resources')

diff --git a/doc-tool/resources/_layouts/api-page.html b/doc-tool/resources/_layouts/api-page.html
index 0e39f9d91..f45a8bab4 100644
--- a/doc-tool/resources/_layouts/api-page.html
+++ b/doc-tool/resources/_layouts/api-page.html
@@ -1,5 +1,5 @@
 ---
-layout: doc
+layout: sidebar
 extraCSS:
     - css/api-page.css
 ---
diff --git a/doc-tool/resources/_layouts/blog-page.html b/doc-tool/resources/_layouts/blog-page.html
new file mode 100644
index 000000000..b99a16b9c
--- /dev/null
+++ b/doc-tool/resources/_layouts/blog-page.html
@@ -0,0 +1,28 @@
+---
+layout: sidebar
+---
+
+<div id="post-title">
+    <h3 id="post-date">
+        {{ page.date | date: '%B %d, %Y' }}
+    </h3>
+    <h1 id="main-title">{{ page.title }}</h1>
+    {% if page.subTitle %}
+    <h2 id="sub-title">{{ page.subTitle }}</h2>
+    {% endif %}
+</div>
+
+<div id="blog-post-container">
+    {{ content }}
+</div>
+
+{% if page.author %}
+<div id="post-footer">
+    {% if page.authorImg %}
+    <img id="author-image" src="{{ site.baseurl }}/{{ page.authorImg }}">
+    {% endif %}
+    <span id="post-author">
+        {% if page.authorImg == null %}- {% endif %}{{ page.author }}
+    </span>
+</div>
+{% endif %}
diff --git a/doc-tool/resources/_layouts/blog.html b/doc-tool/resources/_layouts/blog.html
deleted file mode 100644
index d7a08414a..000000000
--- a/doc-tool/resources/_layouts/blog.html
+++ /dev/null
@@ -1,28 +0,0 @@
----
-layout: doc
----
-
-<div id="post-title">
-    <h3 id="post-date">
-        {{ page.date | date: '%B %d, %Y' }}
-    </h3>
-    <h1 id="main-title">{{ page.title }}</h1>
-    {% if page.subTitle %}
-    <h2 id="sub-title">{{ page.subTitle }}</h2>
-    {% endif %}
-</div>
-
-<div id="blog-post-container">
-    {{ content }}
-</div>
-
-{% if page.author %}
-<div id="post-footer">
-    {% if page.authorImg %}
-    <img id="author-image" src="{{ site.baseurl }}/{{ page.authorImg }}">
-    {% endif %}
-    <span id="post-author">
-        {% if page.authorImg == null %}- {% endif %}{{ page.author }}
-    </span>
-</div>
-{% endif %}
diff --git a/doc-tool/resources/_layouts/doc-page.html b/doc-tool/resources/_layouts/doc-page.html
index 876e90c95..14220aef7 100644
--- a/doc-tool/resources/_layouts/doc-page.html
+++ b/doc-tool/resources/_layouts/doc-page.html
@@ -1,5 +1,5 @@
 ---
-layout: doc
+layout: sidebar
 ---
 
 <h1 id="doc-page-title">{{ page.title }}</h1>
diff --git a/doc-tool/resources/_layouts/doc.html b/doc-tool/resources/_layouts/doc.html
deleted file mode 100644
index b3947c884..000000000
--- a/doc-tool/resources/_layouts/doc.html
+++ /dev/null
@@ -1,49 +0,0 @@
----
-layout: main
----
-
-<div id="content-wrapper">
-    <div class="index-wrapper">
-        {% include "toc" %}
-        <ul class="index-entities">
-        {% if docs.size > 0 %}
-        <li class="index-title">
-            <span>API</span>
-        </li>
-        {% endif %}
-        {% for pkg in docs %}
-            <li class="index-entity entity-package">
-                <a class="entity-name" href="{{ site.baseurl }}/api/{{ pkg.path | join: "/" }}/index.html">{{ pkg.name }}</a>
-            </li>
-            {% for member in pkg.children %}
-                {% if member.kind == "object" and member.hasCompanion %}
-                {% elsif member.kind != "package" %}
-                <li class="index-entity {% if member.hasCompanion %} with-companion {% endif %}">
-                    <div class="entity-kinds">
-                        {% if member.hasCompanion %}
-                        <a class="letter-anchor object" href="{{ site.baseurl }}/api/{{ member.companionPath | join: "/" }}.html">O</a>
-                        {% endif %}
-                        <a class="letter-anchor {{ member.kind }}" href="{{ site.baseurl }}/api/{{ member.path | join: "/" }}.html">{{ member.kind | first | capitalize }}</a>
-                    </div>
-                    <a class="entity-name" href="{{ site.baseurl }}/api/{{ member.path | join: "/" }}.html">{{ member.name }}</a>
-                </li>
-                {% endif %}
-            {% endfor %}
-        {% endfor %}
-        </ul>
-    </div>
-    <div id="content-body">
-        <div id="menu-toggle" onclick="toggleMenu()">
-            <i class="fa fa-bars" aria-hidden="true"></i>
-        </div>
-        {{ content }}
-    </div>
-</div>
-
-
-<script>
-function toggleMenu() {
-    var wrapper = document.getElementById("content-wrapper");
-    wrapper.classList.toggle("toggled");
-}
-</script>
diff --git a/doc-tool/resources/_layouts/sidebar.html b/doc-tool/resources/_layouts/sidebar.html
new file mode 100644
index 000000000..b3947c884
--- /dev/null
+++ b/doc-tool/resources/_layouts/sidebar.html
@@ -0,0 +1,49 @@
+---
+layout: main
+---
+
+<div id="content-wrapper">
+    <div class="index-wrapper">
+        {% include "toc" %}
+        <ul class="index-entities">
+        {% if docs.size > 0 %}
+        <li class="index-title">
+            <span>API</span>
+        </li>
+        {% endif %}
+        {% for pkg in docs %}
+            <li class="index-entity entity-package">
+                <a class="entity-name" href="{{ site.baseurl }}/api/{{ pkg.path | join: "/" }}/index.html">{{ pkg.name }}</a>
+            </li>
+            {% for member in pkg.children %}
+                {% if member.kind == "object" and member.hasCompanion %}
+                {% elsif member.kind != "package" %}
+                <li class="index-entity {% if member.hasCompanion %} with-companion {% endif %}">
+                    <div class="entity-kinds">
+                        {% if member.hasCompanion %}
+                        <a class="letter-anchor object" href="{{ site.baseurl }}/api/{{ member.companionPath | join: "/" }}.html">O</a>
+                        {% endif %}
+                        <a class="letter-anchor {{ member.kind }}" href="{{ site.baseurl }}/api/{{ member.path | join: "/" }}.html">{{ member.kind | first | capitalize }}</a>
+                    </div>
+                    <a class="entity-name" href="{{ site.baseurl }}/api/{{ member.path | join: "/" }}.html">{{ member.name }}</a>
+                </li>
+                {% endif %}
+            {% endfor %}
+        {% endfor %}
+        </ul>
+    </div>
+    <div id="content-body">
+        <div id="menu-toggle" onclick="toggleMenu()">
+            <i class="fa fa-bars" aria-hidden="true"></i>
+        </div>
+        {{ content }}
+    </div>
+</div>
+
+
+<script>
+function toggleMenu() {
+    var wrapper = document.getElementById("content-wrapper");
+    wrapper.classList.toggle("toggled");
+}
+</script>
diff --git a/doc-tool/resources/css/dottydoc.css b/doc-tool/resources/css/dottydoc.css
index aa197de07..54f74b66f 100644
--- a/doc-tool/resources/css/dottydoc.css
+++ b/doc-tool/resources/css/dottydoc.css
@@ -26,6 +26,55 @@ div.index-wrapper {
     overflow-x: hidden;
 }
 
+div#doc-page-container > h1 {
+    border-bottom: 1px solid #eee;
+    padding-bottom: 0.3em;
+}
+
+div#doc-page-container > h1 {
+    margin: 3rem 0 0.5rem 0;
+}
+
+div#doc-page-container > h3 {
+    font-size: 1.5rem;
+}
+
+div#doc-page-container > h4 {
+    font-size: 1.25rem;
+}
+
+div#doc-page-container > h5 {
+    font-size: 1rem;
+}
+
+div#doc-page-container > h1 > a,
+div#doc-page-container > h2 > a,
+div#doc-page-container > h3 > a,
+div#doc-page-container > h4 > a,
+div#doc-page-container > h5 > a,
+div#doc-page-container > h6 > a {
+    text-decoration: none;
+    color: #373a3c;
+}
+
+div#doc-page-container > h1 > a:hover,
+div#doc-page-container > h2 > a:hover,
+div#doc-page-container > h3 > a:hover,
+div#doc-page-container > h4 > a:hover,
+div#doc-page-container > h5 > a:hover,
+div#doc-page-container > h6 > a:hover {
+    text-decoration: underline;
+}
+
+div#doc-page-container > h1 > a:focus,
+div#doc-page-container > h2 > a:focus,
+div#doc-page-container > h3 > a:focus,
+div#doc-page-container > h4 > a:focus,
+div#doc-page-container > h5 > a:focus,
+div#doc-page-container > h6 > a:focus {
+    outline: none;
+}
+
 div#content-body {
     border-left: 1px solid #e0e0e0;
     box-shadow: -3px 0px 5px -2px rgba(0,0,0,0.14);
@@ -232,7 +281,7 @@ div#doc-page-container {
 }
 
 div#doc-page-container > p + h1 {
-    margin-bottom: 40px;
+    margin-bottom: 20px;
 }
 
 div#post-footer > img#author-image {
-- 
cgit v1.2.3