Merge pull request #182 from jLukeC/master
Feature Documentation - Section Landing Pages
This commit is contained in:
commit
8caace5de0
@ -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.
|
||||||
|
@ -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
2
docs/01_Examples/index.md
Normal 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.
|
@ -33,8 +33,8 @@
|
|||||||
else {
|
else {
|
||||||
if (empty($options['languages'])) return $base_doc;
|
if (empty($options['languages'])) return $base_doc;
|
||||||
else {
|
else {
|
||||||
$t = array_keys($base_doc);
|
$t = array_keys($base_doc);
|
||||||
return $base_doc[$t[0]];
|
return $base_doc[$t[0]];
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
} else {
|
} else {
|
||||||
|
Loading…
Reference in New Issue
Block a user