Improve readability of the theme, fixes #363

justinwalsh · May 5, 2016 · 1127cc6 · 1127cc6
1 parent b472a82
commit 1127cc6
Show file tree

Hide file tree

Showing 115 changed files with 765 additions and 991 deletions.
diff --git a/.gitignore b/.gitignore
@@ -4,4 +4,4 @@ node_modules
 /sftp-config.json
 static
 
-vendor
+/vendor
diff --git a/docs/01_Features/Auto_Syntax_Highlight.md b/docs/01_Features/Auto_Syntax_Highlight.md
@@ -4,18 +4,18 @@ Here is a quick example :
 
 **HTML (with inline css and javascript)**
 
-	<!DOCTYPE html>
-	<title>Title</title>
+    <!DOCTYPE html>
+    <title>Title</title>
 
-	<style>body {width: 500px;}</style>
+    <style>body {width: 500px;}</style>
 
-	<script type="application/javascript">
-	  function $init() {return true;}
-	</script>
+    <script type="application/javascript">
+      function $init() {return true;}
+    </script>
 
-	<body>
-	  <p checked class="title" id='title'>Title</p>
-	  <!-- here goes the rest of the page -->
-	</body>
+    <body>
+      <p checked class="title" id='title'>Title</p>
+      <!-- here goes the rest of the page -->
+    </body>
 
 [See the full list of supported languages in Daux.io](!Examples/Code_Highlighting)
diff --git a/docs/01_Features/Landing_page.md b/docs/01_Features/Landing_page.md
@@ -2,9 +2,9 @@ If you want to create a beautiful landing page for your project, create a `_inde
 
 ```json
 {
-	"title": "Daux.io",
-	"tagline": "The Easiest Way To Document Your Project",
-	"image": "app.png"
+    "title": "Daux.io",
+    "tagline": "The Easiest Way To Document Your Project",
+    "image": "app.png"
 }
 ```
 
@@ -14,8 +14,8 @@ To disable the automatic landing page, you can set `auto_landing` to false in th
 
 ```json
 {
-	"html": {
-		"auto_landing": false
+    "html": {
+        "auto_landing": false
     }
 }
 ```
diff --git a/docs/01_Features/Live_mode.md b/docs/01_Features/Live_mode.md
@@ -2,7 +2,7 @@ Keep in mind, this mode can be used for production, but it is not recommended.
 
 The whole directory must be scanned on each request. This might not make a big impact on small documentations but can be a bottleneck on bigger ones.
 
-### Running Locally
+## Running Locally
 
 There are several ways to run the docs locally. You can use something like <a href="http://www.mamp.info/en/index.html" target="_blank">MAMP</a> or <a href="http://www.wampserver.com/en/" target="_blank">WAMP</a>.
 
@@ -11,9 +11,9 @@ The easiest is to use PHP 5.4's built-in server.
 For that i've included a short command, run `./serve` in the projects folder to start the local web server. By default the server will run at: <a href="http://localhost:8085" target="_blank">http://localhost:8085</a>
 
 
-### Running Remotely
+## Running Remotely
 
-#### Clean URLs configuration
+### Clean URLs configuration
 
 Daux provides native support for Clean URLs provided the webserver has its URL Rewrite module enabled.
 To enable the same, set the toggle in the `config.json` file in the `/docs` folder.
@@ -26,13 +26,13 @@ To enable the same, set the toggle in the `config.json` file in the `/docs` fold
 }
 ```
 
-#### Apache
+### Apache
 
 Copy the files from the repo to a web server that can run PHP 5.3 or greater.
 
 There is an included `.htaccess` for Apache web server.
 
-#### Nginx
+### Nginx
 
 Daux.io works perfectly fine on Nginx too, just drop this configuration in your `nginx.conf`
 
@@ -66,14 +66,14 @@ server {
 }
 ```
 
-### IIS
+## IIS
 
 If you have set up a local or remote IIS web site, you may need a `web.config` with:
 
 * A rewrite configuration, for handling clean urls.
 * A mime type handler for less files, if using a custom theme.
 
-#### Clean URLs
+### Clean URLs
 
 The `web.config` needs an entry for `<rewrite>` under `<system.webServer>`:
 

diff --git a/docs/01_Features/Search.md b/docs/01_Features/Search.md
@@ -6,8 +6,8 @@ To enable the generated search, you can set `search` to true in the `html` secti
 
 ```json
 {
-	"html": {
-		"search": true
+    "html": {
+        "search": true
     }
 }
 ```
diff --git a/docs/01_Features/Table_of_contents.md b/docs/01_Features/Table_of_contents.md
@@ -18,8 +18,8 @@ You can enable this feature in your configuration
 
 ```json
 {
-	"html": {
-		"auto_toc": true
+    "html": {
+        "auto_toc": true
     }
 }
 ```

diff --git a/docs/05_Configuration/Confluence_upload.md b/docs/05_Configuration/Confluence_upload.md
@@ -4,9 +4,9 @@ The connection requires three parameters `base_url`, `user` and `pass`. While `u
 ```json
 {
     "confluence": {
-		"base_url": "http://my_confluence_server.com/,
-		"user" : "my_username",
-		"pass" : "my_password",
+        "base_url": "http://my_confluence_server.com/",
+        "user" : "my_username",
+        "pass" : "my_password",
     }
 }
 ```
@@ -36,7 +36,7 @@ Because confluence can't have two pages with the same name in a space, I recomme
 
 ```json
 {
-	"confluence": { "prefix": "[DAUX]" }
+    "confluence": { "prefix": "[DAUX]" }
 }
 ```
 
@@ -45,7 +45,7 @@ To make the upload quicker, we try to determine if a page changed or not, first
 
 ```json
 {
-	"confluence": { "update_threshold": 1 }
+    "confluence": { "update_threshold": 1 }
 }
 ```
 
@@ -63,7 +63,7 @@ By default, it will inform you that some pages aren't needed anymore and you can
 
 ```json
 {
-	"confluence": { "delete": true }
+    "confluence": { "delete": true }
 }
 ```
 
@@ -79,7 +79,9 @@ You can add a text in a "information" macro on top of the document by setting th
 
 ```json
 {
-	"confluence": { "header": "These pages are updated automatically, your changes will be overriden." }
+    "confluence": {
+        "header": "These pages are updated automatically, your changes will be overriden."
+    }
 }
 ```
 

diff --git a/docs/05_Configuration/Html_export.md b/docs/05_Configuration/Html_export.md
@@ -17,7 +17,7 @@ To use a custom theme, just copy over the theme folder into the `themes` directo
 
 ```json
 {
-	"html": { "theme": "new-theme" }
+    "html": { "theme": "new-theme" }
 }
 ```
 
@@ -26,7 +26,7 @@ By default your code blocks will be floated to a column on the right side of you
 
 ```json
 {
-	"html": { "float": false }
+    "html": { "float": false }
 }
 ```
 
@@ -35,7 +35,7 @@ Some users might wish to hide the code blocks & view just the documentation. By
 
 ```json
 {
-	"html": { "toggle_code": true }
+    "html": { "toggle_code": true }
 }
 ```
 
@@ -45,7 +45,7 @@ Add a 'Fork me on GitHub' ribbon.
 
 ```json
 {
-	"html": { "repo": "justinwalsh/daux.io" }
+    "html": { "repo": "justinwalsh/daux.io" }
 }
 ```
 
@@ -54,7 +54,7 @@ Include twitter follow buttons in the sidebar.
 
 ```json
 {
-	"html": { "twitter": ["justin_walsh", "todaymade"] }
+    "html": { "twitter": ["justin_walsh", "todaymade"] }
 }
 ```
 
@@ -63,13 +63,13 @@ Include custom links in the sidebar.
 
 ```json
 {
-	"html": {
-	    "links": {
-		    "GitHub Repo": "https://github.com/justinwalsh/daux.io",
-		    "Help/Support/Bugs": "https://github.com/justinwalsh/daux.io/issues",
-		    "Made by Todaymade": "http://todaymade.com"
-	    }
-	}
+    "html": {
+        "links": {
+            "GitHub Repo": "https://github.com/justinwalsh/daux.io",
+            "Help/Support/Bugs": "https://github.com/justinwalsh/daux.io/issues",
+            "Made by Todaymade": "http://todaymade.com"
+        }
+    }
 }
 ```
 
@@ -78,7 +78,7 @@ This will embed the google analytics tracking code.
 
 ```json
 {
-	"html": { "google_analytics": "UA-XXXXXXXXX-XX" }
+    "html": { "google_analytics": "UA-XXXXXXXXX-XX" }
 }
 ```
 
@@ -87,15 +87,15 @@ This will embed the piwik tracking code.
 
 ```json
 {
-	"html": { "piwik_analytics": "my-url-for-piwik.com" }
+    "html": { "piwik_analytics": "my-url-for-piwik.com" }
 }
 ```
 
 You can Also give a specific Piwik ID as well.
 
 ```json
 {
-	"html": { "piwik_analytics_id": "43" }
+    "html": { "piwik_analytics_id": "43" }
 }
 ```
 
@@ -105,8 +105,8 @@ Daux.io provides the option to present page titles as breadcrumb navigation. You
 ```json
 {
     "html": {
-		"breadcrumbs": true,
-		"breadcrumb_separator" : " > "
+        "breadcrumbs": true,
+        "breadcrumb_separator" : " > "
     }
 }
 ```
@@ -116,6 +116,6 @@ By default, daux.io will display the last modified time as reported by the syste
 
 ```json
 {
-	"html": { "date_modified": false }
+    "html": { "date_modified": false }
 }
 ```
diff --git a/docs/05_Configuration/_index.md b/docs/05_Configuration/_index.md
@@ -5,7 +5,7 @@ Change the title bar in the docs
 
 ```json
 {
-	"title": "Daux.io"
+    "title": "Daux.io"
 }
 ```
 
@@ -14,7 +14,7 @@ Change the tagline bar in the docs
 
 ```json
 {
-	"tagline": "The Easiest Way To Document Your Project"
+    "tagline": "The Easiest Way To Document Your Project"
 }
 ```
 
@@ -23,20 +23,20 @@ Change the documentation's author
 
 ```json
 {
-	"author": "Stéphane Goetz"
+    "author": "Stéphane Goetz"
 }
 ```
 
 ### Ignore
 Set custom files and entire folders to ignore within your `/docs` folder. For files make sure to include the file extension in the name. For both files and folders, names are case-sensitive.
 
 ```json
-	{
-		"ignore": {
-			"files": ["Work_In_Progress.md"],
-			"folders": ["99_Not_Ready"]
-		}
-	}
+    {
+        "ignore": {
+            "files": ["Work_In_Progress.md"],
+            "folders": ["99_Not_Ready"]
+        }
+    }
 ```
 
 ### Timezone
@@ -85,7 +85,7 @@ be read by the integrated web server. And you set the other formats (like conflu
 
 ```json
 {
-	"format": "html"
+    "format": "html"
 }
 ```