Add section about ignoring files

This commit is contained in:
Samy Pesse
2016-02-24 22:29:19 +01:00
parent 5b20027f2e
commit 4bf5dc6646
2 changed files with 20 additions and 2 deletions
-1
View File
@@ -9,7 +9,6 @@
* [Directory structure](structure.md)
* [Pages and Summary](pages.md)
* [Assets and Images](assets.md)
* [Glossary](glossary.md)
* [Multi-Lingual](langs.md)
* [Configuration](config.md)
+20 -1
View File
@@ -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: