summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorSamy Pessé <samypesse@gmail.com>2016-02-29 17:35:12 +0100
committerSamy Pessé <samypesse@gmail.com>2016-02-29 17:35:12 +0100
commitec353e179dedf1ebf1ab6e54f6217a88d087ea75 (patch)
tree4a6e90f89a56ea571c0a090e6a524f760da8aa3b /docs
parent496f253e698f1224fa9f9cf88670648ff3930d7a (diff)
downloadgitbook-ec353e179dedf1ebf1ab6e54f6217a88d087ea75.zip
gitbook-ec353e179dedf1ebf1ab6e54f6217a88d087ea75.tar.gz
gitbook-ec353e179dedf1ebf1ab6e54f6217a88d087ea75.tar.bz2
Remove .gitbook and add "root" option
Diffstat (limited to 'docs')
-rw-r--r--docs/book.js11
-rw-r--r--docs/config.md1
-rw-r--r--docs/structure.md10
3 files changed, 7 insertions, 15 deletions
diff --git a/docs/book.js b/docs/book.js
deleted file mode 100644
index 988abb2..0000000
--- a/docs/book.js
+++ /dev/null
@@ -1,11 +0,0 @@
-var pkg = require('../package.json');
-
-module.exports = {
- title: 'GitBook Documentation',
-
- plugins: ['theme-official'],
- theme: 'official',
- variables: {
- version: pkg.version
- }
-};
diff --git a/docs/config.md b/docs/config.md
index 060a9d0..41dab1d 100644
--- a/docs/config.md
+++ b/docs/config.md
@@ -6,6 +6,7 @@ GitBook allows you to customize your book using a flexible configuration. These
| Variable | Description |
| -------- | ----------- |
+| `root` | Path to the root folder containing the content |
| `title` | Title of your book, default value is extracted from the README. On GitBook.com this field is pre-filled. |
| `description` | Description of your book, default value is extracted from the README. On GitBook.com this field is pre-filled. |
| `author` | Name of the author. On GitBook.com this field is pre-filled. |
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"
+}
```