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

Merge pull request #182 from jLukeC/master

Browse Source 
Feature Documentation - Section Landing Pages
This commit is contained in:
Denis Kisselev 2014-06-11 10:26:58 -07:00
commit 8caace5de0
4 changed files with 11 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -77,6 +77,10 @@ If you want to create a beautiful landing page for your project, simply create a
Note: The image can be a local or remote image. Note: The image can be a local or remote image.
## Section landing page
If you are interested in having a landing page for a subsection of your docs, all you need to do is add an `index.md` file to the folder. For example, `/docs/01_Examples` has a landing page for that section since there exists a `/docs/01_Examples/index.md` file.
## 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. 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.

3
docs/00_Getting_Started.md
View File

@ -77,6 +77,9 @@ If you want to create a beautiful landing page for your project, simply create a
Note: The image can be a local or remote image. Note: The image can be a local or remote image.
## Section landing page
If you are interested in having a landing page for a subsection of your docs, all you need to do is add an `index.md` file to the folder. For example, `/docs/01_Examples` has a landing page for that section since there exists a `/docs/01_Examples/index.md` file.
## 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. 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.

2
docs/01_Examples/index.md Normal file
View File

@ -0,0 +1,2 @@
### This is a landing page for the Examples section
Adding a landing page is pretty simple, all you need to do is add an "index.md" file to the related folder.