From 4bf5dc6646f6f14ce734695f3a3ca007813bc99a Mon Sep 17 00:00:00 2001 From: Samy Pesse Date: Wed, 24 Feb 2016 22:29:19 +0100 Subject: [PATCH] Add section about ignoring files --- docs/SUMMARY.md | 1 - docs/structure.md | 21 ++++++++++++++++++++- 2 files changed, 20 insertions(+), 2 deletions(-) diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index 12871cff3..d8c436bba 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -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) diff --git a/docs/structure.md b/docs/structure.md index 2cb94601a..18c4abb09 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: