.md
file.# Title
) in the .md
file and instead will give that page the title defined in the SUMMARY.md
file that determines the GitBook table of contents and file menu. In general, top level headers are not that critical, so best leave them out of the .md
file unless you want pages in GitBook to have 2 different titles at the top.SUMMARY.md
file. White space matters! To add a new entry to the TOC, add it to the SUMMARY.md
file..md
files, please a description header to the file:../../
- this is shorthand for the repo root, and will, remarkably, work both in GitBook and GitHub. You can also use relative links, such as ./boba-straw/README.md
but they will obviously break when the parent README.md
file is moved./README.md
to paths. So, for example, GitBook will autocomplete this path ../../boba_examples/boba-straw
to ../../boba_examples/boba-straw/README.md
, which is great if that file actually exists but otherwise will give you a 404 error (which is not great)./../../
is completely different than ../../
. The first one will not work universally, but ../../
will so please use that../boba_documentation/.gitbook/assets
. To show an image in a documentation file, access it like this: