diff options
author | Samy Pessé <samypesse@gmail.com> | 2016-02-23 15:25:50 +0100 |
---|---|---|
committer | Samy Pessé <samypesse@gmail.com> | 2016-02-23 15:25:50 +0100 |
commit | 6b0a4f20bf544178c8ba2938b082111ac6d22c1d (patch) | |
tree | 0c635a06423f4d10dd28f194c4cbe305041f59c6 /docs | |
parent | f052aacee1140f211ebb9454157fa7a3604005cf (diff) | |
download | gitbook-6b0a4f20bf544178c8ba2938b082111ac6d22c1d.zip gitbook-6b0a4f20bf544178c8ba2938b082111ac6d22c1d.tar.gz gitbook-6b0a4f20bf544178c8ba2938b082111ac6d22c1d.tar.bz2 |
Add documentation for .gitbook
Diffstat (limited to 'docs')
-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/ +``` |