From 1b89808ecb6fe0f8893384dd1ed109c8b9313b86 Mon Sep 17 00:00:00 2001 From: Luke Carlson Date: Wed, 11 Jun 2014 12:52:35 -0400 Subject: [PATCH] described how to use section landing pages --- README.md | 4 ++++ docs/00_Getting_Started.md | 3 +++ 2 files changed, 7 insertions(+) diff --git a/README.md b/README.md index a0ba1ed..996e6a8 100755 --- a/README.md +++ b/README.md @@ -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. +## 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 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. diff --git a/docs/00_Getting_Started.md b/docs/00_Getting_Started.md index d1b0413..96c5029 100644 --- a/docs/00_Getting_Started.md +++ b/docs/00_Getting_Started.md @@ -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. +## 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 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.