About this documentation
This document aims to be a comprehensive guide to the @gitbook-ng/gitbook command line tool, version 3.3.5.
Glossary
Allows you to specify terms and their respective definitions to be displayed as annotations. Based on those terms, GitBook will automatically build an index and highlight those terms in pages.
Directory structure
For software projects, you can use a subdirectory (like docs/) to store the book for the project's documentation. You can configure the root option to indicate the folder where GitBook can find the book's files:
Markdown
GitBook supports a nice way for explicitly setting the header ID. If you follow the header text with an opening curly bracket (separated from the text with a least one space), a hash, the ID and a closing curly bracket, the ID is set on the header. If you use the trailing hash feature of atx ...
🌐
GitBook
gitbook.com › docs › getting-started › quickstart
Quickstart | GitBook Documentation
August 12, 2026 - This quickstart guide explains how to get set up in GitBook and publish your first docs site in minutes.
🌐
Thomas Suedbroecker
suedbroecker.net › 2020 › 05 › 14 › get-started-with-gitbook-and-github-a-small-guide
Get started with GitBook and GitHub a small guide – Thomas Suedbroecker's Blog
December 1, 2021 - In this blog post I want to point out the great documentation topic GitBook. The first time I noticed GitBook, was in a hands-on workshop, when I asked the presenters how they create and update their good looking workshop documentation. I directly tried out the free GitBook version for one of my GitHub projects and…
🌐
GitBook
gitbook.com › docs › developers › getting-started › setup-guide
Quickstart | Developers | GitBook Documentation
August 13, 2025 - After creating a GitBook account, you'll be able to create a personal access token in your developer settings.
🌐
secretGeek
til.secretgeek.net › gitbook › use_gitbook_locally.html
Use gitbook locally - Today I Learned - secretGeek.net
Once gitbook-cli is installed, thereafter, from the root of the repo you're working on, you run...
🌐
Medium
medium.com › @richdayandnight › simple-tutorial-on-hosting-your-gitbook-documentation-on-github-pages-bonus-with-gitbook-editor-f27f60d5d408
Simple tutorial on hosting your Gitbook documentation on Github pages (bonus: with Gitbook Editor) | by Rich Yap | Medium
June 9, 2020 - Yes, the first version of Gitbook is no longer maintained. The Gitbook team shifted focus to creating a beautiful online editor that allows you to instantly deploy pages using the https://<username>.gitbook.io/<gitbook_name> pattern, which is great! I totally recommend this if you just want to deploy pages and make them available to public similar to sharing a public google doc.
🌐
Gitbook
developer.gitbook.com › getting-started › setup-guide
Quickstart | Developers | GitBook Documentation
August 2, 2024 - After creating a GitBook account, you'll be able to create a personal access token in your developer settings.
🌐
GitBook
docs.gitbook.com › developers › getting-started › setup-guide
Quickstart | GitBook Documentation
March 28, 2025 - You’ll need a GitBook account to start using the developer platform.
Find elsewhere
🌐
Beacamp Library
blog.beacamp.com › getting-started-with-gitbook
Getting Started with GitBook: A Comprehensive Guide - DevMar Library
April 15, 2024 - In developer relations, technical writers and developer advocates play a crucial role in creating and managing such documentation. This blog post will demonstrate how to set up a GitBook for your company and use it to share documentation effectively.
🌐
npm
npmjs.com › package › gitbook
gitbook - npm
October 11, 2018 - Library and cmd utility to generate GitBooks. Latest version: 2.6.9, last published: 8 years ago. Start using gitbook in your project by running `npm i gitbook`. There are 34 other projects in the npm registry using gitbook.
      » npm install gitbook
    
Published: Oct 11, 2018
Version: 2.6.9
🌐
Ardusub
ardusub.com › developers › building-docs.html
Build this Documentation · GitBook
npm install gitbook-cli -g · git clone path/to/repo · cd path/to/repo gitbook install · cd path/to/repo gitbook serve · The documentation is served at localhost:4000 by default. Sponsored by Blue Robotics. Code released under the GPLv3 License. Documentation released under the CC-NC-SA 4.0.
🌐
Medium
medium.com › @techwritershub › how-to-use-gitbook-for-technical-documentation-d333e3a250af
How to Use GitBook for Technical Documentation | by TechWriters Hub | Medium
July 24, 2024 - Learn to create, customize, and publish technical docs with GitBook. The step-by-step guide covers setup, content creation, GitHub integration, and more.
🌐
Gitbooks
tomcam.gitbooks.io › gitbook-tutorial › first-gitbook.html
Create and publish your first GitBook · Gitbook tutorial
Choose the Book & Manual template. It's the best choice for this tutorial because it requires you to learn the most about GitBook.
🌐
Medium
medium.com › beacamp-pub › getting-started-with-gitbook-a-comprehensive-guide-63c8a19fcbb9
Getting Started with GitBook: A Comprehensive Guide | by Sophia Iroegbu | Beacamp Pub | Medium
April 16, 2024 - In developer relations, technical writers and developer advocates play a crucial role in creating and managing such documentation. This blog post will demonstrate how to set up a GitBook for your company and use it to share documentation effectively.
🌐
YouTube
youtube.com › watch
Gitbook Tutorial 2025: How To Use Gitbook (Step-By-Step) - YouTube
Gitbook Tutorial 2025: How To Use Gitbook (Step-By-Step)In this video we show you how to use gitbook. This video will cover everything that you need to know ...
Published: October 17, 2023