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

Document the ability to supply a custom docs path

Browse Source
This commit is contained in:
Paul Stanton 2013-08-22 22:26:07 +01:00
parent 6b041596fb
commit fd86353ab3
2 changed files with 28 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -31,10 +31,12 @@ Download this repository as a zip, and unpack. Copy the files to a web server th
## 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. By default, 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 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.
If you'd prefer to keep your docs somewhere else (like outside of the daux.io root directory) you can specify your docs path in the `config.json` file.
## Files ## Files
The generator will look for Markdown `*.md` files inside the `/docs` folder and any of the subfolders within /docs. The generator will look for Markdown `*.md` files inside the `/docs` folder and any of the subfolders within /docs.
@ -82,6 +84,17 @@ Change the title bar in the docs
} }
``` ```
###Docs Path:
If you'd prefer to keep your docs outside of the Daux.io directory, you can provide the filepath.
Note: Your `config.json` file will need to remain in `/daux.io/docs`.
```json
{
"docs_path": "../../my_docs"
}
```
###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:

15
docs/00_Getting_Started.md
View File

@ -31,10 +31,12 @@ Download this repository as a zip, and unpack. Copy the files to a web server th
## 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. By default, 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 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.
If you'd prefer to keep your docs somewhere else (like outside of the daux.io root directory) you can specify your docs path in the `config.json` file.
## Files ## Files
The generator will look for Markdown `*.md` files inside the `/docs` folder and any of the subfolders within /docs. The generator will look for Markdown `*.md` files inside the `/docs` folder and any of the subfolders within /docs.
@ -82,6 +84,17 @@ Change the title bar in the docs
} }
``` ```
###Docs Path:
If you'd prefer to keep your docs outside of the Daux.io directory, you can provide the filepath.
Note: Your `config.json` file will need to remain in `/daux.io/docs`.
```json
{
"docs_path": "../../my_docs"
}
```
###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: