.gitbook/assets
folder manages every file used in any page.SUMMARY.md
file tells GitBook in which order we wish to display our pages and what groups there are in our documentation.README.md
file in the main folder has the contents of the first page users see when accessing the documentation website.a-group-of-pages
).README.md
file with the contents of the parent page must be added to the folder named after the parent page title..md
extension./
as many times you need. Add either a README.md
file or a normal Markdown file with any name you want.README.md
creates a page with the same name of your new folder. Markdown files with any other name will create pages with a title using the first h1 heading.SUMMARY.md
file, and remember to link them to their source file. New unsorted pages should be added as items on an unordered list:#
symbol (a hash) is an element called anchor. On GitBook, anchors are created by replacing every blank space in a section title with -
(hyphens). Therefore,#getting-familiar-with-git
#understanding-gitbooks-integration-with-github
main
branch on GitHub for an old version of the page with the broken link. That will help you figure out to which page that link was originally pointing to..gitbook.yaml
to point that specific path to the right page. But other times (probably when we make aggressive changes to the folder structure—their versioning system doesn't seem to like it that much), you will have to update that link manually. To do so, hover your mouse to the old link and edit it by searching for the title of the page to be mentioned.documentation
channel on Slack.