Merge pull request #67 from Stanton/master
Allow docs path to be configured in config.json
This commit is contained in:
commit
0a247e6102
15
README.md
15
README.md
@ -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:
|
||||||
|
|
||||||
|
@ -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:
|
||||||
|
|
||||||
|
@ -1,6 +1,7 @@
|
|||||||
{
|
{
|
||||||
"title": "DAUX.IO",
|
"title": "DAUX.IO",
|
||||||
"tagline": "The Easiest Way To Document Your Project",
|
"tagline": "The Easiest Way To Document Your Project",
|
||||||
|
"docs_path": "docs",
|
||||||
"image": "img/app.png",
|
"image": "img/app.png",
|
||||||
"theme": "navy",
|
"theme": "navy",
|
||||||
"date_modified": true,
|
"date_modified": true,
|
||||||
|
@ -66,7 +66,7 @@ software, even if advised of the possibility of such damage.
|
|||||||
require_once('libs/functions.php');
|
require_once('libs/functions.php');
|
||||||
|
|
||||||
$options = get_options();
|
$options = get_options();
|
||||||
$tree = get_tree("docs", $base_url);
|
$tree = get_tree($options['docs_path'], $base_url);
|
||||||
$homepage_url = homepage_url($tree);
|
$homepage_url = homepage_url($tree);
|
||||||
$docs_url = docs_url($tree);
|
$docs_url = docs_url($tree);
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user