D3Public/daux.io
8
0
Fork 0
Code Pull Requests Releases Activity

Updating Readme

Browse Source
This commit is contained in:
Justin Walsh 2013-06-04 13:23:01 -05:00
parent 9aa3408bef
commit aaf607026e
2 changed files with 86 additions and 56 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

71
README.md
View File

@ -1,62 +1,76 @@
**TM Docs** is a 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 frendly way. **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.
## Features ## Features
* Supports Github Flavored Markdown * Supports GitHub Flavored Markdown
* Auto Syntax Hightlighting * Auto Syntax Highlighting
* Auto Generated Navigation * Auto Generated Navigation
* 12 Built-in Bootstrap themes * 12 Built-In Bootstrap Themes
* 35 Syntax hightlighting themes * 35 Syntax Highlighting Themes
* Shareable/Linkable SEO Friendly URLs * Shareable/Linkable SEO Friendly URLs
* Built on Bootstrap * Built On Bootstrap
* No build step * No Build Step
* Git/SVN Friendly * Git/SVN Friendly
## Demos
This is a list of sites using TM-Docs:
* [TodayCMS Docs](http://docs.todaymade.com)
Use TM-Docs? Send me a pull request or open an issue and I will add you to the list.
## Download ## Download
Download this repository as a zip, and unpack. Copy the files to a webserver that can run php. You can also run the documentation locally using Grunt.js which is covered at the end of this readme. Download this repository as a zip, and unpack. Copy the files to a web server that can run PHP. You can also run the documentation locally using Grunt.js, which is covered at the end of this readme.
## Folders ## 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. It also contains a `Markdown Tests` folder which contains the official suite of tests for checking the functionality of the Markdown parser.
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 the folders any number of levels to get the exact structure you want. The folder structure will be converted to the nested navigation.
## Files ## 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 your subfolders.
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: 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:
**Good** **Good:**
01_Getting_Started.md = Getting Started
API_Calls.md = API Calls
200_Something_Else-Cool.md = Something Else-Cool
**Bad** * 01_Getting_Started.md = Getting Started
File Name With Space.md = FAIL * API_Calls.md = API Calls
* 200_Something_Else-Cool.md = Something Else-Cool
**Bad:**
* File Name With Space.md = FAIL
## Sorting ## Sorting
To sort your files and folders in a specific way, you can prefix them with a number and underscore. Ex. `/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 striped 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 alpha-numeric sorting, which is the default. The numbers will be stripped out of the navigation.
## Configuration ## 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** 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:**
Change the title bar in the docs Change the title bar in the docs
{ {
"title": "TM-Docs the Todaymade Documentation Generator" "title": "TM-Docs the Todaymade Documentation Generator"
} }
**Default Homepage** **Default Homepage:**
Set the default page someone is redirected to if they visit `/` Set the default page someone is redirected to if they visit `/`
{ {
"homepage": "/Getting_Started" "homepage": "/Getting_Started"
} }
**Bootstrap Theme** **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. 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.
View the <a href="http://bootswatch.com/" target="_blank">**Demos**</a> View the <a href="http://bootswatch.com/" target="_blank">**Demos**</a>
@ -65,8 +79,8 @@ View the <a href="http://bootswatch.com/" target="_blank">**Demos**</a>
"theme": "spacelab" "theme": "spacelab"
} }
**Syntax Hightlighting** **Syntax Highlighting:**
We support all of the availible themes for highlight.js. To use one of the themes, set this option to one of the availible style names. 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 <a href="http://softwaremaniacs.org/media/soft/highlight/test.html" target="_blank">**Demos**</a> View the <a href="http://softwaremaniacs.org/media/soft/highlight/test.html" target="_blank">**Demos**</a>
View the <a href="https://github.com/isagalaev/highlight.js/tree/master/src/styles" target="_blank">**Possible Option Values**</a> View the <a href="https://github.com/isagalaev/highlight.js/tree/master/src/styles" target="_blank">**Possible Option Values**</a>
@ -75,21 +89,21 @@ View the <a href="https://github.com/isagalaev/highlight.js/tree/master/src/styl
"hightlight": "dark" "hightlight": "dark"
} }
**Github Repo** **Github Repo:**
Add a 'Fork me on Github' ribbon. Add a 'Fork me on Github' ribbon.
{ {
"repo": "justinwalsh/tm-docs" "repo": "justinwalsh/tm-docs"
} }
**Twitter** **Twitter:**
Include twitter follow buttons in the sidebar. Include twitter follow buttons in the sidebar.
{ {
"twitter": ["justin_walsh", "todaymade"] "twitter": ["justin_walsh", "todaymade"]
} }
**Links** **Links:**
Include custom links in the sidebar. Include custom links in the sidebar.
{ {
@ -105,13 +119,14 @@ Include custom links in the sidebar.
You can run the docs locally using <a href="http://gruntjs.com/" target="_blank">Grunt.js</a> You can run the docs locally using <a href="http://gruntjs.com/" target="_blank">Grunt.js</a>
**Requirements:** **Requirements:**
* Node.js * Node.js
* npm * npm
* Grunt.js * Grunt.js
* PHP 5.4 or greater * PHP 5.4 or greater
This project contains a package.json file, so once you have the requirements installed, you can simply run a `npm install` and then `grunt` in the projects folder, to start the local webserver. By default the server will run at: <a href="http://localhost:8085" target="_blank">http://localhost:8085</a> This project contains a package.json file, so once you have the requirements installed, you can simply run a `npm install` and then `grunt` 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>
### Support ## Support
If you need help using TM Docs, or have found a bug, please create an issue on the <a href="http://localhost:8085" target="_blank">Github repo</a>. If you need help using TM Docs, or have found a bug, please create an issue on the <a href="http://localhost:8085" target="_blank">Github repo</a>.

71
docs/00_Getting_Started.md
View File

@ -1,62 +1,76 @@
**TM Docs** is a 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 frendly way. **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.
## Features ## Features
* Supports Github Flavored Markdown * Supports GitHub Flavored Markdown
* Auto Syntax Hightlighting * Auto Syntax Highlighting
* Auto Generated Navigation * Auto Generated Navigation
* 12 Built-in Bootstrap themes * 12 Built-In Bootstrap Themes
* 35 Syntax hightlighting themes * 35 Syntax Highlighting Themes
* Shareable/Linkable SEO Friendly URLs * Shareable/Linkable SEO Friendly URLs
* Built on Bootstrap * Built On Bootstrap
* No build step * No Build Step
* Git/SVN Friendly * Git/SVN Friendly
## Demos
This is a list of sites using TM-Docs:
* [TodayCMS Docs](http://docs.todaymade.com)
Use TM-Docs? Send me a pull request or open an issue and I will add you to the list.
## Download ## Download
Download this repository as a zip, and unpack. Copy the files to a webserver that can run php. You can also run the documentation locally using Grunt.js which is covered at the end of this readme. Download this repository as a zip, and unpack. Copy the files to a web server that can run PHP. You can also run the documentation locally using Grunt.js, which is covered at the end of this readme.
## Folders ## 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. It also contains a `Markdown Tests` folder which contains the official suite of tests for checking the functionality of the Markdown parser.
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 the folders any number of levels to get the exact structure you want. The folder structure will be converted to the nested navigation.
## Files ## 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 your subfolders.
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: 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:
**Good** **Good:**
01_Getting_Started.md = Getting Started
API_Calls.md = API Calls
200_Something_Else-Cool.md = Something Else-Cool
**Bad** * 01_Getting_Started.md = Getting Started
File Name With Space.md = FAIL * API_Calls.md = API Calls
* 200_Something_Else-Cool.md = Something Else-Cool
**Bad:**
* File Name With Space.md = FAIL
## Sorting ## Sorting
To sort your files and folders in a specific way, you can prefix them with a number and underscore. Ex. `/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 striped 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 alpha-numeric sorting, which is the default. The numbers will be stripped out of the navigation.
## Configuration ## 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** 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:**
Change the title bar in the docs Change the title bar in the docs
{ {
"title": "TM-Docs the Todaymade Documentation Generator" "title": "TM-Docs the Todaymade Documentation Generator"
} }
**Default Homepage** **Default Homepage:**
Set the default page someone is redirected to if they visit `/` Set the default page someone is redirected to if they visit `/`
{ {
"homepage": "/Getting_Started" "homepage": "/Getting_Started"
} }
**Bootstrap Theme** **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. 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.
View the <a href="http://bootswatch.com/" target="_blank">**Demos**</a> View the <a href="http://bootswatch.com/" target="_blank">**Demos**</a>
@ -65,8 +79,8 @@ View the <a href="http://bootswatch.com/" target="_blank">**Demos**</a>
"theme": "spacelab" "theme": "spacelab"
} }
**Syntax Hightlighting** **Syntax Highlighting:**
We support all of the availible themes for highlight.js. To use one of the themes, set this option to one of the availible style names. 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 <a href="http://softwaremaniacs.org/media/soft/highlight/test.html" target="_blank">**Demos**</a> View the <a href="http://softwaremaniacs.org/media/soft/highlight/test.html" target="_blank">**Demos**</a>
View the <a href="https://github.com/isagalaev/highlight.js/tree/master/src/styles" target="_blank">**Possible Option Values**</a> View the <a href="https://github.com/isagalaev/highlight.js/tree/master/src/styles" target="_blank">**Possible Option Values**</a>
@ -75,21 +89,21 @@ View the <a href="https://github.com/isagalaev/highlight.js/tree/master/src/styl
"hightlight": "dark" "hightlight": "dark"
} }
**Github Repo** **Github Repo:**
Add a 'Fork me on Github' ribbon. Add a 'Fork me on Github' ribbon.
{ {
"repo": "justinwalsh/tm-docs" "repo": "justinwalsh/tm-docs"
} }
**Twitter** **Twitter:**
Include twitter follow buttons in the sidebar. Include twitter follow buttons in the sidebar.
{ {
"twitter": ["justin_walsh", "todaymade"] "twitter": ["justin_walsh", "todaymade"]
} }
**Links** **Links:**
Include custom links in the sidebar. Include custom links in the sidebar.
{ {
@ -105,13 +119,14 @@ Include custom links in the sidebar.
You can run the docs locally using <a href="http://gruntjs.com/" target="_blank">Grunt.js</a> You can run the docs locally using <a href="http://gruntjs.com/" target="_blank">Grunt.js</a>
**Requirements:** **Requirements:**
* Node.js * Node.js
* npm * npm
* Grunt.js * Grunt.js
* PHP 5.4 or greater * PHP 5.4 or greater
This project contains a package.json file, so once you have the requirements installed, you can simply run a `npm install` and then `grunt` in the projects folder, to start the local webserver. By default the server will run at: <a href="http://localhost:8085" target="_blank">http://localhost:8085</a> This project contains a package.json file, so once you have the requirements installed, you can simply run a `npm install` and then `grunt` 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>
### Support ## Support
If you need help using TM Docs, or have found a bug, please create an issue on the <a href="http://localhost:8085" target="_blank">Github repo</a>. If you need help using TM Docs, or have found a bug, please create an issue on the <a href="http://localhost:8085" target="_blank">Github repo</a>.