summaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorSamy Pessé <samypesse@gmail.com>2014-04-02 01:04:01 -0700
committerSamy Pessé <samypesse@gmail.com>2014-04-02 01:04:01 -0700
commit03cbe7b18f392b4f7ba8d9e304793bc338e43118 (patch)
tree3237749f1750892452b63c6071da234f367e458e /README.md
parent85f4c3be581b9b4c7ea4959955c73b4dd86306b2 (diff)
downloadgitbook-03cbe7b18f392b4f7ba8d9e304793bc338e43118.zip
gitbook-03cbe7b18f392b4f7ba8d9e304793bc338e43118.tar.gz
gitbook-03cbe7b18f392b4f7ba8d9e304793bc338e43118.tar.bz2
Add information about summary format
Diffstat (limited to 'README.md')
-rw-r--r--README.md25
1 files changed, 25 insertions, 0 deletions
diff --git a/README.md b/README.md
index 6d37943..9a87f38 100644
--- a/README.md
+++ b/README.md
@@ -30,3 +30,28 @@ Options for commands `build` and `serve` are:
-i, --intro <intro> Description of the book to generate
-g, --github <repo_path> ID of github repo like : username/repo
```
+
+## Book Format
+
+A book is a GitHub repository containing at least 2 files: `README.md` and `SUMMARY.md`.
+
+#### SUMMARY.md
+
+The SUMMARY.md is used for getting the complete summary of the book. It should contains a list of items (deep items are allowed) with links to the different pages.
+
+Example:
+
+```
+# Summary
+
+This is the summary of my book.
+
+* [section 1](section1/README.md)
+ * [example 1](section1/example1.md)
+ * [example 2](section1/example2.md)
+* [section 2](section2/README.md)
+ * [example 1](section2/example1.md)
+```
+
+All the other content than the summary list will be ignored.
+