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

Copy README to Getting Started

Browse Source
This commit is contained in:
Justin Walsh 2013-07-28 20:58:19 -05:00
parent 6bc1c0fe2b
commit d9e9ee3de6
1 changed files with 67 additions and 46 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

113
docs/00_Getting_Started.md
View File

@ -21,6 +21,7 @@
This is a list of sites using Daux.io: This is a list of sites using Daux.io:
* [Daux.io](http://daux.io) * [Daux.io](http://daux.io)
* [Munee: Standalone PHP 5.3 Asset Optimisation & Manipulation](http://mun.ee)
Do you use Daux.io? Send me a pull request or open an [issue](https://github.com/justinwalsh/daux.io/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/daux.io/issues) and I will add you to the list.
@ -58,11 +59,13 @@ To sort your files and folders in a specific way, you can prefix them with a num
If you want to create a beautiful landing page for your project, simply create a `index.md` file in the root of the `/docs` folder. This file will then be used to create a landing page. You can also add a tagline and image to this page using the config file like this: If you want to create a beautiful landing page for your project, simply create a `index.md` file in the root of the `/docs` folder. This file will then be used to create a landing page. You can also add a tagline and image to this page using the config file like this:
{ ```json
"title": "Daux.io", {
"tagline": "The Easiest Way To Document Your Project", "title": "Daux.io",
"image": "img/app.png" "tagline": "The Easiest Way To Document Your Project",
} "image": "img/app.png"
}
```
Note: The image can be a local or remote image. Note: The image can be a local or remote image.
@ -73,9 +76,11 @@ To customize the look and feel of your documentation, you can create a `config.j
###Title: ###Title:
Change the title bar in the docs Change the title bar in the docs
{ ```json
"title": "Daux.io" {
} "title": "Daux.io"
}
```
###Themes: ###Themes:
We have 4 built-in Bootstrap themes. To use one of the themes, just set the `theme` option to one of the following: We have 4 built-in Bootstrap themes. To use one of the themes, just set the `theme` option to one of the following:
@ -85,7 +90,7 @@ We have 4 built-in Bootstrap themes. To use one of the themes, just set the `the
* navy * navy
* red * red
``` ```json
{ {
"theme": "blue" "theme": "blue"
} }
@ -94,78 +99,94 @@ We have 4 built-in Bootstrap themes. To use one of the themes, just set the `the
###Custom Theme: ###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: 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:
{ ```json
"theme": "custom", {
"colors": { "theme": "custom",
"sidebar-background": "#f7f7f7", "colors": {
"sidebar-hover": "#c5c5cb", "sidebar-background": "#f7f7f7",
"lines": "#e7e7e9", "sidebar-hover": "#c5c5cb",
"dark": "#3f4657", "lines": "#e7e7e9",
"light": "#82becd", "dark": "#3f4657",
"text": "#2d2d2d", "light": "#82becd",
"syntax-string": "#022e99", "text": "#2d2d2d",
"syntax-comment": "#84989b", "syntax-string": "#022e99",
"syntax-number": "#2f9b92", "syntax-comment": "#84989b",
"syntax-label": "#840d7a" "syntax-number": "#2f9b92",
} "syntax-label": "#840d7a"
} }
}
```
###Code Floating: ###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`. 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`.
{ ```json
"float": false {
} "float": false
}
```
###GitHub Repo: ###GitHub Repo:
Add a 'Fork me on GitHub' ribbon. Add a 'Fork me on GitHub' ribbon.
{ ```json
"repo": "justinwalsh/daux.io" {
} "repo": "justinwalsh/daux.io"
}
```
###Twitter: ###Twitter:
Include twitter follow buttons in the sidebar. Include twitter follow buttons in the sidebar.
{ ```json
"twitter": ["justin_walsh", "todaymade"] {
} "twitter": ["justin_walsh", "todaymade"]
}
```
###Links: ###Links:
Include custom links in the sidebar. Include custom links in the sidebar.
{ ```json
"links": { {
"GitHub Repo": "https://github.com/justinwalsh/daux.io", "links": {
"Help/Support/Bugs": "https://github.com/justinwalsh/daux.io/issues", "GitHub Repo": "https://github.com/justinwalsh/daux.io",
"Made by Todaymade": "http://todaymade.com" "Help/Support/Bugs": "https://github.com/justinwalsh/daux.io/issues",
} "Made by Todaymade": "http://todaymade.com"
} }
}
```
###Google Analytics: ###Google Analytics:
This will embed the google analytics tracking code. This will embed the google analytics tracking code.
{ ```json
"google_analytics": "UA-XXXXXXXXX-XX" {
} "google_analytics": "UA-XXXXXXXXX-XX"
}
```
###Piwik Analytics: ###Piwik Analytics:
This will embed the piwik tracking code. This will embed the piwik tracking code.
{ ```json
"piwik_analytics": "my-url-for-piwik.com" {
} "piwik_analytics": "my-url-for-piwik.com"
}
```
###Ignore: ###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. 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": { "ignore": {
files: ["Work_In_Progress.md"], "files": ["Work_In_Progress.md"],
folders: ["99_Not_Ready"] "folders": ["99_Not_Ready"]
} }
} }
```
## Running Remotely ## Running Remotely