GlossaryĪllows you to specify terms and their respective definitions to be displayed in the glossary. You can see a complete example with the Learn Git book. Each language should be a sub-directory following the normal GitBook format, and a file named LANGS.md should be present at the root of the repository with the following format: * (en/) GitBook supports building books written in multiple languages. It should contain a list of chapters, linking to their respective pages.įiles that are not included in SUMMARY.md will not be processed by gitbook. The SUMMARY.md defines your book's structure. It will be automatically added to the final summary.
Typically, this should be the introduction for your book. myrepo -format=json.Ī book is a Git repository containing at least 2 files: README.md and SUMMARY.md.
Generate this format using: gitbook build.
You can serve a repository as a book using: $ gitbook serve
#GITBOOK EDITOR DOWNLOAD INSTALL#
GitBook can be installed from NPM using: $ npm install gitbook-cli -gĬreate the directories and files for a book from its SUMMARY.md file (if existing) using $ gitbook init You can publish and host book easily online using, a desktop editor is also available.Ĭheck out the GitBook Community Slack Channel, Stay updated by following on Twitter or GitBook on Facebook.Ĭomplete documentation is available at. GitBook is a command line tool (and Node.js library) for building beautiful books using GitHub/Git and Markdown (or AsciiDoc).