summaryrefslogtreecommitdiffstats
path: root/docs/structure.md
diff options
context:
space:
mode:
authorSamy Pesse <samypesse@gmail.com>2016-02-24 22:29:19 +0100
committerSamy Pesse <samypesse@gmail.com>2016-02-24 22:29:19 +0100
commit4bf5dc6646f6f14ce734695f3a3ca007813bc99a (patch)
treef795b7b93106a1f45d6a0ba117305e79be92c694 /docs/structure.md
parent5b20027f2ec4939a546f11753fb1098cde3b9a59 (diff)
downloadgitbook-4bf5dc6646f6f14ce734695f3a3ca007813bc99a.zip
gitbook-4bf5dc6646f6f14ce734695f3a3ca007813bc99a.tar.gz
gitbook-4bf5dc6646f6f14ce734695f3a3ca007813bc99a.tar.bz2
Add section about ignoring files
Diffstat (limited to 'docs/structure.md')
-rw-r--r--docs/structure.md21
1 files changed, 20 insertions, 1 deletions
diff --git a/docs/structure.md b/docs/structure.md
index 2cb9460..18c4abb 100644
--- a/docs/structure.md
+++ b/docs/structure.md
@@ -24,7 +24,26 @@ An overview of what each of these does:
| `SUMMARY.md` | Table of Contents |
-### Sub-directory
+### Static files and Images
+
+A static file is a file that is not listed in the `SUMMARY.md`. All static files, not [ignored](#ignore), are copied to the output.
+
+### Ignoring files & folders {#ignore}
+
+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`:
+
+```
+# This is a comment
+
+# Ignore the file test.md
+test.md
+
+# Ignore everything in the directory "bin"
+bin/*
+```
+
+### Project documentation / Sub-directory
For project documentaiton, it sometimes better to use a diretcory (like `docs/`) to store the prject's documentation. You can use a `.gitbook` file to indicate to GitBook in which folder the book is stored: