summaryrefslogtreecommitdiffstats
path: root/docs/structure.md
diff options
context:
space:
mode:
authorSamy Pessé <samypesse@gmail.com>2016-03-07 10:10:38 +0100
committerSamy Pessé <samypesse@gmail.com>2016-03-07 10:10:38 +0100
commit4150455c3e7e8f70b6534be352766d9c37ac9a8c (patch)
tree70cba0132a1ce7421e2d145bf0c58a20e7adb1ff /docs/structure.md
parent008aacb5c23e1d91b230cc2a5f170626bc788449 (diff)
downloadgitbook-4150455c3e7e8f70b6534be352766d9c37ac9a8c.zip
gitbook-4150455c3e7e8f70b6534be352766d9c37ac9a8c.tar.gz
gitbook-4150455c3e7e8f70b6534be352766d9c37ac9a8c.tar.bz2
Improve docs
Diffstat (limited to 'docs/structure.md')
-rw-r--r--docs/structure.md12
1 files changed, 7 insertions, 5 deletions
diff --git a/docs/structure.md b/docs/structure.md
index 907f3e0..02b196e 100644
--- a/docs/structure.md
+++ b/docs/structure.md
@@ -1,6 +1,8 @@
-# Directory structure
+# Directory Structure
-GitBook uses a simple directory structure:
+GitBook uses a simple directory structure. All Markdown/Asciidoc files listed in the [SUMMARY](pages.md) will be transformed as HTML. Multi-Lingual books have a slightly [different structure](languages.md).
+
+A basic GitBook usually looks something like this:
```
.
@@ -21,8 +23,8 @@ An overview of what each of these does:
| -------- | ----------- |
| `book.json` | Stores [configuration](config.md) data (__optional__) |
| `README.md` | Preface / Introduction for your book (**required**) |
-| `SUMMARY.md` | Table of Contents |
-
+| `SUMMARY.md` | Table of Contents (See [Pages](pages.md)) (__optional__) |
+| `GLOSSARY.md` | Lexicon / List of terms to annotate (See [Glossary](lexicon.md)) (__optional__) |
### Static files and Images
@@ -33,7 +35,7 @@ A static file is a file that is not listed in the `SUMMARY.md`. All static files
GitBook will read the `.gitignore`, `.bookignore` and `.ignore` files to get a list of files and folders to skip.
The format inside those files, follows the same convention as `.gitignore`:
-```markdown
+```
# This is a comment
# Ignore the file test.md