diff options
author | Samy Pessé <samypesse@gmail.com> | 2016-02-21 11:01:49 +0100 |
---|---|---|
committer | Samy Pessé <samypesse@gmail.com> | 2016-02-21 11:01:49 +0100 |
commit | 40f829ce54d6fe8c56c1005ed7229d198918acb9 (patch) | |
tree | 534b2ac9fd35afd8fe3251d4104aac26aa12ed13 /docs/structure.md | |
parent | e16b3e35f438014cb51fac84a500c8996d18658d (diff) | |
download | gitbook-40f829ce54d6fe8c56c1005ed7229d198918acb9.zip gitbook-40f829ce54d6fe8c56c1005ed7229d198918acb9.tar.gz gitbook-40f829ce54d6fe8c56c1005ed7229d198918acb9.tar.bz2 |
Add docs for setup gitbook
Diffstat (limited to 'docs/structure.md')
-rw-r--r-- | docs/structure.md | 26 |
1 files changed, 26 insertions, 0 deletions
diff --git a/docs/structure.md b/docs/structure.md new file mode 100644 index 0000000..f6ae617 --- /dev/null +++ b/docs/structure.md @@ -0,0 +1,26 @@ +# Directory structure + + +``` +. +├── book.json +├── README.md +├── SUMMARY.md +├── chapter-1/ +| ├── README.md +| └── something.md +└── chapter-2/ + ├── README.md + └── something.md +``` + +An overview of what each of these does: + +| File | Description | +| -------- | ----------- | +| `book.json` | Stores [configuration](config.md) data (__optional__) | +| `README.md` | Preface / Introduction for your book (**required**) | +| `SUMMARY.md` | Table of Contents | + + +### Sub-directory |