diff options
author | Samy Pessé <samypesse@gmail.com> | 2016-02-29 17:35:12 +0100 |
---|---|---|
committer | Samy Pessé <samypesse@gmail.com> | 2016-02-29 17:35:12 +0100 |
commit | ec353e179dedf1ebf1ab6e54f6217a88d087ea75 (patch) | |
tree | 4a6e90f89a56ea571c0a090e6a524f760da8aa3b /docs/structure.md | |
parent | 496f253e698f1224fa9f9cf88670648ff3930d7a (diff) | |
download | gitbook-ec353e179dedf1ebf1ab6e54f6217a88d087ea75.zip gitbook-ec353e179dedf1ebf1ab6e54f6217a88d087ea75.tar.gz gitbook-ec353e179dedf1ebf1ab6e54f6217a88d087ea75.tar.bz2 |
Remove .gitbook and add "root" option
Diffstat (limited to 'docs/structure.md')
-rw-r--r-- | docs/structure.md | 10 |
1 files changed, 6 insertions, 4 deletions
diff --git a/docs/structure.md b/docs/structure.md index 31b00f6..ca35c01 100644 --- a/docs/structure.md +++ b/docs/structure.md @@ -45,18 +45,20 @@ bin/* ### Project documentation / Sub-directory {#subdirectory} -For project documentaiton, it sometimes better to use a diretcory (like `docs/`) to store the prject's documentation. You can use a `.gitbook` file to indicate to GitBook in which folder the book is stored: +For software project, it sometimes better to use a diretcory (like `docs/`) to store the project's documentation. You can use the [`root` option](config.md) to indicate to GitBook in which folder the book is stored: ``` . -├── .gitbook +├── book.json └── docs/ ├── README.md └── SUMMARY.md ``` -With `.gitbook` containing: +With `book.json` containing: ``` -./docs/ +{ + "root": "./docs" +} ``` |