summaryrefslogtreecommitdiffstats
path: root/docs/pages.md
diff options
context:
space:
mode:
authorSamy Pesse <samypesse@gmail.com>2016-02-24 22:42:11 +0100
committerSamy Pesse <samypesse@gmail.com>2016-02-24 22:42:11 +0100
commitd7d0429169ea097dcd51d9622036390433410944 (patch)
tree3fff6da3e0bf55eda5c7457e2ef1afb1afca89f7 /docs/pages.md
parent4bf5dc6646f6f14ce734695f3a3ca007813bc99a (diff)
downloadgitbook-d7d0429169ea097dcd51d9622036390433410944.zip
gitbook-d7d0429169ea097dcd51d9622036390433410944.tar.gz
gitbook-d7d0429169ea097dcd51d9622036390433410944.tar.bz2
Add doc section about summary
Diffstat (limited to 'docs/pages.md')
-rw-r--r--docs/pages.md36
1 files changed, 36 insertions, 0 deletions
diff --git a/docs/pages.md b/docs/pages.md
new file mode 100644
index 0000000..e72ffad
--- /dev/null
+++ b/docs/pages.md
@@ -0,0 +1,36 @@
+# Pages and Summary
+
+GitBook uses a `SUMMARY.md` file to define the structure of chapters and subchapters of the book. The `SUMMARY.md` file is used to generate the book's table of contents.
+
+The `SUMMARY.md`'s format is simply a list of links, the title of the link is used as the chapter's title, and the target is a path to that chapter's file.
+
+Subchapters are defined simply by adding a nested list to a parent chapter.
+
+### Simple example
+
+```
+# Summary
+
+* [Part I](part1/README.md)
+ * [Writing is nice](part1/writing.md)
+ * [GitBook is nice](part1/gitbook.md)
+* [Part II](part2/README.md)
+ * [We love feedback](part2/feedback_please.md)
+ * [Better tools for authors](part2/better_tools.md)
+```
+
+### Example with subchapters split into parts
+
+```
+# Summary
+
+### Part 1
+
+* [Writing is nice](part1/writing.md)
+* [GitBook is nice](part1/gitbook.md)
+
+### Part 2
+
+* [We love feedback](part2/feedback_please.md)
+* [Better tools for authors](part2/better_tools.md)
+```