diff --git a/README.md b/README.md
index edc652f..69f8d83 100644
--- a/README.md
+++ b/README.md
@@ -1,24 +1,25 @@
-**TM Docs** is an auto documentation generator that uses your folder structure and Markdown files to create custom documentation on the fly. It helps create great looking documentation in a developer friendly way.
+**Daux.io** is an documentation generator that uses a simple folder structure and Markdown files to create custom documentation on the fly. It helps you create great looking documentation in a developer friendly way.
## Features
+* 100% Mobile responsive
* Supports GitHub Flavored Markdown
* Auto Syntax Highlighting
* Auto Generated Navigation
-* 12 Built-In Bootstrap Themes
-* 35 Syntax Highlighting Themes
+* 4 Built-In Themes or roll your own
* Shareable/Linkable SEO Friendly URLs
* Built On Bootstrap
* No Build Step
* Git/SVN Friendly
+* Optional code float layout
## Demos
-This is a list of sites using TM-Docs:
+This is a list of sites using Daux.io:
* [TodayCMS Docs](http://docs.todaymade.com)
-Do you use TM-Docs? Send me a pull request or open an [issue](https://github.com/justinwalsh/tm-docs/issues) and I will add you to the list.
+Do you use Daux.io? Send me a pull request or open an [issue](https://github.com/justinwalsh/tm-docs/issues) and I will add you to the list.
## Download
@@ -26,13 +27,13 @@ Download this repository as a zip, and unpack. Copy the files to a web server th
## Folders
-The generator will look for folders in the `/docs` folder. Add your folders inside the `/docs` folder. This project contains some example folders and files to get you started. It also contains a `Markdown Tests` folder which contains the official suite of tests for checking the functionality of the Markdown parser.
+The generator will look for folders in the `/docs` folder. Add your folders inside the `/docs` folder. This project contains some example folders and files to get you started.
-You can nest the folders any number of levels to get the exact structure you want. The folder structure will be converted to the nested navigation.
+You can nest folders any number of levels to get the exact structure you want. The folder structure will be converted to the nested navigation.
## Files
-The generator will look for Markdown files inside the `/docs` folder and any of your subfolders.
+The generator will look for Markdown files inside the `/docs` folder and any of the subfolders within /docs.
You must use the `.md` file extension for your files. Also, you must use underscores instead of spaces. Here are some example file names and what they will be converted to:
@@ -49,61 +50,82 @@ You must use the `.md` file extension for your files. Also, you must use undersc
## Sorting
-To sort your files and folders in a specific way, you can prefix them with a number and underscore, e.g. `/docs/01_Hello_World.md` and `/docs/05_Features.md` This will list *Hello World* before *Features*, overriding the alpha-numeric sorting, which is the default. The numbers will be stripped out of the navigation.
+To sort your files and folders in a specific way, you can prefix them with a number and underscore, e.g. `/docs/01_Hello_World.md` and `/docs/05_Features.md` This will list *Hello World* before *Features*, overriding the deafult alpha-numeric sorting. The numbers will be stripped out of the navigation and urls.
## Configuration
To customize the look and feel of your documentation, you can create a `config.json` file in the of the `/docs` folder. The `config.json` file is a simple JSON object that you can use to change some of the basic settings of the documentation.
-**Title:**
+###Title:
Change the title bar in the docs
{
- "title": "TM-Docs the Todaymade Documentation Generator"
+ "title": "Daux.io"
}
-**Default Homepage:**
+###Default Homepage:
Set the default page someone is redirected to if they visit `/`
{
"homepage": "/Getting_Started"
}
-**Bootstrap Theme:**
-We support the 12 Bootstrap themes from Bootswatch. To use on of the themes, just set this option to the lowercase name of the theme.
+###Themes:
+We have 4 built-in Bootstrap themes. To use one of the themes, just set the `theme` option to one of the following:
-View the **Demos**
+* blue
+* green
+* navy
+* red
+```
+{
+ "theme": "blue"
+}
+```
+
+###Custom Theme:
+To create a custom color scheme, set the `theme` property to `custom` and then define the required colors. Copy the following configuration to get started:
{
- "theme": "spacelab"
+ "theme": "custom"
+ "colors": {
+ "sidebar-background": "#f7f7f7",
+ "sidebar-hover": "#c5c5cb",
+ "lines": "#e7e7e9",
+ "dark": "#3f4657",
+ "light": "#82becd",
+ "text": "#2d2d2d",
+ "syntax-string": "#022e99",
+ "syntax-comment": "#84989b",
+ "syntax-number": "#2f9b92",
+ "syntax-label": "#840d7a"
+ }
}
-**Syntax Highlighting:**
-We support all of the available themes for highlight.js. To use one of the themes, set this option to one of the available style names.
-
-View the **Demos**
-View the **Possible Option Values**
+###Code Floating:
+By deafult your code blocks will be floated to a column on the right side of your content. To disable this feature, set the `float` property to `false`.
{
- "hightlight": "dark"
+ "float": false
}
-**Github Repo:**
+
+###Github Repo:
Add a 'Fork me on Github' ribbon.
{
"repo": "justinwalsh/tm-docs"
}
-**Twitter:**
+###Twitter:
Include twitter follow buttons in the sidebar.
{
"twitter": ["justin_walsh", "todaymade"]
}
-**Links:**
+###Links:
Include custom links in the sidebar.
{
@@ -116,7 +138,7 @@ Include custom links in the sidebar.
## Running Locally
-You can run the docs locally using Grunt.js
+You can run the docs locally using Grunt.js I assume you are familiar with how to use Grunt and have the latest version of PHP 5.4 installed which is able to run a webserver.
**Requirements:**
@@ -129,4 +151,4 @@ This project contains a package.json file, so once you have the requirements ins
## Support
-If you need help using TM Docs, or have found a bug, please create an issue on the Github repo.
\ No newline at end of file
+If you need help using Daux.io, or have found a bug, please create an issue on the Github repo.
\ No newline at end of file
diff --git a/docs/00_Getting_Started.md b/docs/00_Getting_Started.md
index edc652f..ee4b914 100644
--- a/docs/00_Getting_Started.md
+++ b/docs/00_Getting_Started.md
@@ -1,24 +1,26 @@
-**TM Docs** is an auto documentation generator that uses your folder structure and Markdown files to create custom documentation on the fly. It helps create great looking documentation in a developer friendly way.
+**Daux.io** is an documentation generator that uses a simple folder structure and Markdown files to create custom documentation on the fly. It helps you create great looking documentation in a developer friendly way.
## Features
+* 100% Mobile responsive
* Supports GitHub Flavored Markdown
+* Auto created homepage/landing page
* Auto Syntax Highlighting
* Auto Generated Navigation
-* 12 Built-In Bootstrap Themes
-* 35 Syntax Highlighting Themes
+* 4 Built-In Themes or roll your own
* Shareable/Linkable SEO Friendly URLs
* Built On Bootstrap
* No Build Step
* Git/SVN Friendly
+* Optional code float layout
## Demos
-This is a list of sites using TM-Docs:
+This is a list of sites using Daux.io:
* [TodayCMS Docs](http://docs.todaymade.com)
-Do you use TM-Docs? Send me a pull request or open an [issue](https://github.com/justinwalsh/tm-docs/issues) and I will add you to the list.
+Do you use Daux.io? Send me a pull request or open an [issue](https://github.com/justinwalsh/tm-docs/issues) and I will add you to the list.
## Download
@@ -26,13 +28,13 @@ Download this repository as a zip, and unpack. Copy the files to a web server th
## Folders
-The generator will look for folders in the `/docs` folder. Add your folders inside the `/docs` folder. This project contains some example folders and files to get you started. It also contains a `Markdown Tests` folder which contains the official suite of tests for checking the functionality of the Markdown parser.
+The generator will look for folders in the `/docs` folder. Add your folders inside the `/docs` folder. This project contains some example folders and files to get you started.
-You can nest the folders any number of levels to get the exact structure you want. The folder structure will be converted to the nested navigation.
+You can nest folders any number of levels to get the exact structure you want. The folder structure will be converted to the nested navigation.
## Files
-The generator will look for Markdown files inside the `/docs` folder and any of your subfolders.
+The generator will look for Markdown files inside the `/docs` folder and any of the subfolders within /docs.
You must use the `.md` file extension for your files. Also, you must use underscores instead of spaces. Here are some example file names and what they will be converted to:
@@ -49,61 +51,82 @@ You must use the `.md` file extension for your files. Also, you must use undersc
## Sorting
-To sort your files and folders in a specific way, you can prefix them with a number and underscore, e.g. `/docs/01_Hello_World.md` and `/docs/05_Features.md` This will list *Hello World* before *Features*, overriding the alpha-numeric sorting, which is the default. The numbers will be stripped out of the navigation.
+To sort your files and folders in a specific way, you can prefix them with a number and underscore, e.g. `/docs/01_Hello_World.md` and `/docs/05_Features.md` This will list *Hello World* before *Features*, overriding the deafult alpha-numeric sorting. The numbers will be stripped out of the navigation and urls.
## Configuration
To customize the look and feel of your documentation, you can create a `config.json` file in the of the `/docs` folder. The `config.json` file is a simple JSON object that you can use to change some of the basic settings of the documentation.
-**Title:**
+###Title:
Change the title bar in the docs
{
- "title": "TM-Docs the Todaymade Documentation Generator"
+ "title": "Daux.io"
}
-**Default Homepage:**
+###Default Homepage:
Set the default page someone is redirected to if they visit `/`
{
"homepage": "/Getting_Started"
}
-**Bootstrap Theme:**
-We support the 12 Bootstrap themes from Bootswatch. To use on of the themes, just set this option to the lowercase name of the theme.
+###Themes:
+We have 4 built-in Bootstrap themes. To use one of the themes, just set the `theme` option to one of the following:
-View the **Demos**
+* blue
+* green
+* navy
+* red
+```
+{
+ "theme": "blue"
+}
+```
+
+###Custom Theme:
+To create a custom color scheme, set the `theme` property to `custom` and then define the required colors. Copy the following configuration to get started:
{
- "theme": "spacelab"
+ "theme": "custom",
+ "colors": {
+ "sidebar-background": "#f7f7f7",
+ "sidebar-hover": "#c5c5cb",
+ "lines": "#e7e7e9",
+ "dark": "#3f4657",
+ "light": "#82becd",
+ "text": "#2d2d2d",
+ "syntax-string": "#022e99",
+ "syntax-comment": "#84989b",
+ "syntax-number": "#2f9b92",
+ "syntax-label": "#840d7a"
+ }
}
-**Syntax Highlighting:**
-We support all of the available themes for highlight.js. To use one of the themes, set this option to one of the available style names.
-
-View the **Demos**
-View the **Possible Option Values**
+###Code Floating:
+By deafult your code blocks will be floated to a column on the right side of your content. To disable this feature, set the `float` property to `false`.
{
- "hightlight": "dark"
+ "float": false
}
-**Github Repo:**
+
+###Github Repo:
Add a 'Fork me on Github' ribbon.
{
"repo": "justinwalsh/tm-docs"
}
-**Twitter:**
+###Twitter:
Include twitter follow buttons in the sidebar.
{
"twitter": ["justin_walsh", "todaymade"]
}
-**Links:**
+###Links:
Include custom links in the sidebar.
{
@@ -116,7 +139,7 @@ Include custom links in the sidebar.
## Running Locally
-You can run the docs locally using Grunt.js
+You can run the docs locally using Grunt.js I assume you are familiar with how to use Grunt and have the latest version of PHP 5.4 installed which is able to run a webserver.
**Requirements:**
@@ -129,4 +152,4 @@ This project contains a package.json file, so once you have the requirements ins
## Support
-If you need help using TM Docs, or have found a bug, please create an issue on the Github repo.
\ No newline at end of file
+If you need help using Daux.io, or have found a bug, please create an issue on the Github repo.
\ No newline at end of file
diff --git a/docs/10_Markdown_Tests/Amps_and_angle_encoding.md b/docs/10_Markdown_Tests/Amps_and_angle_encoding.md
deleted file mode 100644
index 0e9527f..0000000
--- a/docs/10_Markdown_Tests/Amps_and_angle_encoding.md
+++ /dev/null
@@ -1,21 +0,0 @@
-AT&T has an ampersand in their name.
-
-AT&T is another way to write it.
-
-This & that.
-
-4 < 5.
-
-6 > 5.
-
-Here's a [link] [1] with an ampersand in the URL.
-
-Here's a link with an amersand in the link text: [AT&T] [2].
-
-Here's an inline [link](/script?foo=1&bar=2).
-
-Here's an inline [link]().
-
-
-[1]: http://example.com/?foo=1&bar=2
-[2]: http://att.com/ "AT&T"
\ No newline at end of file
diff --git a/docs/10_Markdown_Tests/Auto_links.md b/docs/10_Markdown_Tests/Auto_links.md
deleted file mode 100644
index abbc488..0000000
--- a/docs/10_Markdown_Tests/Auto_links.md
+++ /dev/null
@@ -1,13 +0,0 @@
-Link: .
-
-With an ampersand:
-
-* In a list?
-*
-* It should.
-
-> Blockquoted:
-
-Auto-links should not occur here: ``
-
- or here:
\ No newline at end of file
diff --git a/docs/10_Markdown_Tests/Backslash_escapes.md b/docs/10_Markdown_Tests/Backslash_escapes.md
deleted file mode 100644
index 16447a0..0000000
--- a/docs/10_Markdown_Tests/Backslash_escapes.md
+++ /dev/null
@@ -1,104 +0,0 @@
-These should all get escaped:
-
-Backslash: \\
-
-Backtick: \`
-
-Asterisk: \*
-
-Underscore: \_
-
-Left brace: \{
-
-Right brace: \}
-
-Left bracket: \[
-
-Right bracket: \]
-
-Left paren: \(
-
-Right paren: \)
-
-Greater-than: \>
-
-Hash: \#
-
-Period: \.
-
-Bang: \!
-
-Plus: \+
-
-Minus: \-
-
-
-
-These should not, because they occur within a code block:
-
- Backslash: \\
-
- Backtick: \`
-
- Asterisk: \*
-
- Underscore: \_
-
- Left brace: \{
-
- Right brace: \}
-
- Left bracket: \[
-
- Right bracket: \]
-
- Left paren: \(
-
- Right paren: \)
-
- Greater-than: \>
-
- Hash: \#
-
- Period: \.
-
- Bang: \!
-
- Plus: \+
-
- Minus: \-
-
-
-Nor should these, which occur in code spans:
-
-Backslash: `\\`
-
-Backtick: `` \` ``
-
-Asterisk: `\*`
-
-Underscore: `\_`
-
-Left brace: `\{`
-
-Right brace: `\}`
-
-Left bracket: `\[`
-
-Right bracket: `\]`
-
-Left paren: `\(`
-
-Right paren: `\)`
-
-Greater-than: `\>`
-
-Hash: `\#`
-
-Period: `\.`
-
-Bang: `\!`
-
-Plus: `\+`
-
-Minus: `\-`
diff --git a/docs/10_Markdown_Tests/Blockquotes_with_code_blocks.md b/docs/10_Markdown_Tests/Blockquotes_with_code_blocks.md
deleted file mode 100644
index c31d171..0000000
--- a/docs/10_Markdown_Tests/Blockquotes_with_code_blocks.md
+++ /dev/null
@@ -1,11 +0,0 @@
-> Example:
->
-> sub status {
-> print "working";
-> }
->
-> Or:
->
-> sub status {
-> return "working";
-> }
diff --git a/docs/10_Markdown_Tests/Hard-wrapped_paragraphs_with_list-like_lines.md b/docs/10_Markdown_Tests/Hard-wrapped_paragraphs_with_list-like_lines.md
deleted file mode 100644
index f8a5b27..0000000
--- a/docs/10_Markdown_Tests/Hard-wrapped_paragraphs_with_list-like_lines.md
+++ /dev/null
@@ -1,8 +0,0 @@
-In Markdown 1.0.0 and earlier. Version
-8. This line turns into a list item.
-Because a hard-wrapped line in the
-middle of a paragraph looked like a
-list item.
-
-Here's one with a bullet.
-* criminey.
diff --git a/docs/10_Markdown_Tests/Horizontal_rules.md b/docs/10_Markdown_Tests/Horizontal_rules.md
deleted file mode 100644
index 1594bda..0000000
--- a/docs/10_Markdown_Tests/Horizontal_rules.md
+++ /dev/null
@@ -1,67 +0,0 @@
-Dashes:
-
----
-
- ---
-
- ---
-
- ---
-
- ---
-
-- - -
-
- - - -
-
- - - -
-
- - - -
-
- - - -
-
-
-Asterisks:
-
-***
-
- ***
-
- ***
-
- ***
-
- ***
-
-* * *
-
- * * *
-
- * * *
-
- * * *
-
- * * *
-
-
-Underscores:
-
-___
-
- ___
-
- ___
-
- ___
-
- ___
-
-_ _ _
-
- _ _ _
-
- _ _ _
-
- _ _ _
-
- _ _ _
diff --git a/docs/10_Markdown_Tests/Inline_HTML_(Advanced).md b/docs/10_Markdown_Tests/Inline_HTML_(Advanced).md
deleted file mode 100644
index 9d71ddc..0000000
--- a/docs/10_Markdown_Tests/Inline_HTML_(Advanced).md
+++ /dev/null
@@ -1,14 +0,0 @@
-Simple block on one line:
-
-
-
-
-Getting the Gist of Markdown's Formatting Syntax
-------------------------------------------------
-
-This page offers a brief overview of what it's like to use Markdown.
-The [syntax page] [s] provides complete, detailed documentation for
-every feature, but Markdown should be very easy to pick up simply by
-looking at a few examples of it in action. The examples on this page
-are written in a before/after style, showing example syntax and the
-HTML output produced by Markdown.
-
-It's also helpful to simply try Markdown out; the [Dingus] [d] is a
-web application that allows you type your own Markdown-formatted text
-and translate it to XHTML.
-
-**Note:** This document is itself written using Markdown; you
-can [see the source for it by adding '.text' to the URL] [src].
-
- [s]: /projects/markdown/syntax "Markdown Syntax"
- [d]: /projects/markdown/dingus "Markdown Dingus"
- [src]: /projects/markdown/basics.text
-
-
-## Paragraphs, Headers, Blockquotes ##
-
-A paragraph is simply one or more consecutive lines of text, separated
-by one or more blank lines. (A blank line is any line that looks like a
-blank line -- a line containing nothing spaces or tabs is considered
-blank.) Normal paragraphs should not be intended with spaces or tabs.
-
-Markdown offers two styles of headers: *Setext* and *atx*.
-Setext-style headers for `
` and `
` are created by
-"underlining" with equal signs (`=`) and hyphens (`-`), respectively.
-To create an atx-style header, you put 1-6 hash marks (`#`) at the
-beginning of the line -- the number of hashes equals the resulting
-HTML header level.
-
-Blockquotes are indicated using email-style '`>`' angle brackets.
-
-Markdown:
-
- A First Level Header
- ====================
-
- A Second Level Header
- ---------------------
-
- Now is the time for all good men to come to
- the aid of their country. This is just a
- regular paragraph.
-
- The quick brown fox jumped over the lazy
- dog's back.
-
- ### Header 3
-
- > This is a blockquote.
- >
- > This is the second paragraph in the blockquote.
- >
- > ## This is an H2 in a blockquote
-
-
-Output:
-
-
A First Level Header
-
-
A Second Level Header
-
-
Now is the time for all good men to come to
- the aid of their country. This is just a
- regular paragraph.
-
-
The quick brown fox jumped over the lazy
- dog's back.
-
-
Header 3
-
-
-
This is a blockquote.
-
-
This is the second paragraph in the blockquote.
-
-
This is an H2 in a blockquote
-
-
-
-
-### Phrase Emphasis ###
-
-Markdown uses asterisks and underscores to indicate spans of emphasis.
-
-Markdown:
-
- Some of these words *are emphasized*.
- Some of these words _are emphasized also_.
-
- Use two asterisks for **strong emphasis**.
- Or, if you prefer, __use two underscores instead__.
-
-Output:
-
-
Some of these words are emphasized.
- Some of these words are emphasized also.
-
-
Use two asterisks for strong emphasis.
- Or, if you prefer, use two underscores instead.
-
-
-
-## Lists ##
-
-Unordered (bulleted) lists use asterisks, pluses, and hyphens (`*`,
-`+`, and `-`) as list markers. These three markers are
-interchangable; this:
-
- * Candy.
- * Gum.
- * Booze.
-
-this:
-
- + Candy.
- + Gum.
- + Booze.
-
-and this:
-
- - Candy.
- - Gum.
- - Booze.
-
-all produce the same output:
-
-
-
Candy.
-
Gum.
-
Booze.
-
-
-Ordered (numbered) lists use regular numbers, followed by periods, as
-list markers:
-
- 1. Red
- 2. Green
- 3. Blue
-
-Output:
-
-
-
Red
-
Green
-
Blue
-
-
-If you put blank lines between items, you'll get `
` tags for the
-list item text. You can create multi-paragraph list items by indenting
-the paragraphs by 4 spaces or 1 tab:
-
- * A list item.
-
- With multiple paragraphs.
-
- * Another item in the list.
-
-Output:
-
-
-
A list item.
-
With multiple paragraphs.
-
Another item in the list.
-
-
-
-
-### Links ###
-
-Markdown supports two styles for creating links: *inline* and
-*reference*. With both styles, you use square brackets to delimit the
-text you want to turn into a link.
-
-Inline-style links use parentheses immediately after the link text.
-For example:
-
- This is an [example link](http://example.com/).
-
-Output:
-
-
-
-Reference-style links allow you to refer to your links by names, which
-you define elsewhere in your document:
-
- I get 10 times more traffic from [Google][1] than from
- [Yahoo][2] or [MSN][3].
-
- [1]: http://google.com/ "Google"
- [2]: http://search.yahoo.com/ "Yahoo Search"
- [3]: http://search.msn.com/ "MSN Search"
-
-Output:
-
-
I get 10 times more traffic from Google than from Yahoo or MSN.
-
-The title attribute is optional. Link names may contain letters,
-numbers and spaces, but are *not* case sensitive:
-
- I start my morning with a cup of coffee and
- [The New York Times][NY Times].
-
- [ny times]: http://www.nytimes.com/
-
-Output:
-
-
-
-
-### Images ###
-
-Image syntax is very much like link syntax.
-
-Inline (titles are optional):
-
- ![alt text](/path/to/img.jpg "Title")
-
-Reference-style:
-
- ![alt text][id]
-
- [id]: /path/to/img.jpg "Title"
-
-Both of the above examples produce the same output:
-
-
-
-
-
-### Code ###
-
-In a regular paragraph, you can create code span by wrapping text in
-backtick quotes. Any ampersands (`&`) and angle brackets (`<` or
-`>`) will automatically be translated into HTML entities. This makes
-it easy to use Markdown to write about HTML example code:
-
- I strongly recommend against using any `