diff options
Diffstat (limited to 'docs/structure.md')
-rw-r--r-- | docs/structure.md | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/docs/structure.md b/docs/structure.md index f6ae617..2cb9460 100644 --- a/docs/structure.md +++ b/docs/structure.md @@ -1,5 +1,6 @@ # Directory structure +GitBook uses a very simple and obvious directory sttructure: ``` . @@ -24,3 +25,19 @@ An overview of what each of these does: ### 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: + +``` +. +├── .gitbook +└── docs/ + ├── README.md + └── SUMMARY.md +``` + +With `.gitbook` containing: + +``` +./docs/ +``` |