diff options
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 |