Improve docs - Customize template

Emmanouil Konstantinidis · Emmanouil Konstantinidis · commit 8e07b70eec46 · 2016-02-27T21:08:39.000Z
diff --git a/docs/changelog.md b/docs/changelog.md
@@ -1,7 +1,6 @@
 ---
 title:  "Changelog"
 source_filename: "changelog"
-order: 8
 ---
 
 ### Release 0.0.7
diff --git a/docs/contributing.md b/docs/contributing.md
@@ -1,7 +1,6 @@
 ---
 title:  "Contributing & Development"
 source_filename: "contributing"
-order: 7
 ---
 
 ### Development
diff --git a/docs/css/styles.css b/docs/css/styles.css
@@ -16,10 +16,8 @@ body {
   float: right;
 }
 
-.thanks .img-responsive {
-  display: inline-block;
-  max-width: 145px;
-  margin: 10px auto;
+.side-nav {
+  margin-top: 0;
 }
 
 /* @end Misc */
diff --git a/docs/index.md b/docs/index.md
@@ -1,7 +1,6 @@
 ---
 title:  "Home"
 permalink: /
-order: 1
 ---
 
 Django REST Framework Docs (DRF Docs) allows you to list all your API Endpoints that inherit from <a href="http://www.django-rest-framework.org/" target="_blank">Django REST Framework</a> **automatically**. Its purpose is to work out of the box and it should take a minimum to install it.
diff --git a/docs/installation.md b/docs/installation.md
@@ -1,7 +1,6 @@
 ---
 title:  "Installation"
 source_filename: "installation"
-order: 2
 ---
 
 The installation itself should not take more than a couple of minutes. Follow the simple steps below.
diff --git a/docs/live-api.md b/docs/live-api.md
@@ -1,7 +1,6 @@
 ---
 title:  "Live API Endpoints"
 source_filename: "live-api"
-order: 5
 ---
 
 ### What is "Live API Endpoints"?
diff --git a/docs/settings.md b/docs/settings.md
@@ -1,7 +1,6 @@
 ---
 title:  "Settings"
 source_filename: "settings"
-order: 4
 ---
 
 ### How to set the settings
diff --git a/docs/template/base.html b/docs/template/base.html
@@ -43,18 +43,10 @@
 
         {% include "nav.html" %}
 
-        <div class="container-fluid header">
-          <div class="container">
-            <div class="jumbotron">
-              <h1><img class="img-responsive logo-badge" src="{{ base_url }}/images/logo-badge.png" alt="DRF Docs Badge" /></h1>
-              <a target="_blank" href="https://pypi.python.org/pypi/drfdocs/"><img class="img-responsive" src="https://badge.fury.io/py/drfdocs.svg" alt="PyPI version" height="18"></a>
-              <h3>Document Web APIs made with <a href="http://www.django-rest-framework.org/" target="_blank">Django REST Framework</a>.</h3>
-            </div>
-          </div>
-        </div>
+        {% include "header.html" %}
 
         <div class="container">
-            <div class="col-md-3">{% include "toc.html" %}</div>
+            <div class="col-md-3">{% include "side-nav.html" %}</div>
             <div class="col-md-9" role="main">{% include "content.html" %}</div>
         </div>
 
diff --git a/docs/template/content.html b/docs/template/content.html
@@ -6,4 +6,7 @@
 </div>
 {% endif %}
 
-{{ content }}
+<div class="page">
+  {% if page_title %}<h1 class="page-title">{{ page_title }}</h1>{% endif %}
+  {{ content }}
+</div>
diff --git a/docs/template/header.html b/docs/template/header.html
@@ -0,0 +1,9 @@
+<div class="container-fluid header">
+  <div class="container">
+    <div class="jumbotron">
+      <h1><img class="img-responsive logo-badge" src="{{ base_url }}/images/logo-badge.png" alt="DRF Docs Badge" /></h1>
+      <a target="_blank" href="https://pypi.python.org/pypi/drfdocs/"><img class="img-responsive" src="https://badge.fury.io/py/drfdocs.svg" alt="PyPI version" height="18"></a>
+      <h3>Document Web APIs made with <a href="http://www.django-rest-framework.org/" target="_blank">Django REST Framework</a>.</h3>
+    </div>
+  </div>
+</div>
diff --git a/docs/template/nav-sub.html b/docs/template/nav-sub.html
diff --git a/docs/template/side-nav.html b/docs/template/side-nav.html
@@ -0,0 +1,25 @@
+<div class="bs-sidebar hidden-print well" role="complementary">
+    <ul class="nav bs-sidenav side-nav">
+    {% for nav_item in nav %}
+
+        <li {% if nav_item.active %}class="active"{% endif %}>
+            <a href="{{ nav_item.url }}">{{ nav_item.title }}</a>
+
+            <!-- TOC -->
+            {% if nav_item.active %}
+            <ul class="nav pills">
+            {% for toc_item in toc %}
+                <li class="main {% if toc_item.active %}active{% endif %}"><a href="{{ toc_item.url }}">{{ toc_item.title }}</a></li>
+                {% for toc_item in toc_item.children %}
+                    <li><a href="{{ toc_item.url }}">{{ toc_item.title }}</a></li>
+                {% endfor %}
+            {% endfor %}
+            </ul>
+            {% endif %}
+
+        </li>
+
+    {% endfor %}
+
+    </ul>
+</div>
diff --git a/docs/template/toc.html b/docs/template/toc.html
diff --git a/docs/templates.md b/docs/templates.md
@@ -1,7 +1,6 @@
 ---
 title:  "Template Customization"
 source_filename: "templates"
-order: 6
 ---
 
 ### Create the template file

Original file line number	Diff line number	Diff line change
`@@ -16,10 +16,8 @@ body {`
`16`	`16`	`float: right;`
`17`	`17`	`}`
`18`	`18`
`19`		`-.thanks .img-responsive {`
`20`		`- display: inline-block;`
`21`		`- max-width: 145px;`
`22`		`- margin: 10px auto;`
	`19`	`+.side-nav {`
	`20`	`+ margin-top: 0;`
`23`	`21`	`}`
`24`	`22`
`25`	`23`	`/* @end Misc */`