GitBook for VS Code

With the GitBook VS Code extension you can access your docs right in VS Code. Just ask GitBook AI and it’ll summarize an answer for you in seconds.

Getting started

1. Install the extension from the Marketplace.
2. Open the command palette with Command/Control+Shift+P.
3. Run the Welcome: Open Walkthrough... action and select GitBook.
4. The walkthrough will take you through the setup process step by step.

Features

Access your engineering docs, right in VS Code

The GitBook VS Code extension adds a dedicated side panel to the app, so you can ask GitBook AI questions when you need to reference something in your docs.

The extension scans your GitBook documentation and summarizes an answer for you right in the VS Code UI — with clickable references if you want to go read more.

Using the extension

To see the available commands, open the command palette and search “GitBook”. From there, you can change or delete your access token, change your GitBook organization, or ask GitBook AI a question.

Future work

VS Code is an important tool for technical teams, and we want GitBook to integrate seemlessly with your day-to-day tools. Some of the things we're interested in exploring:

• Writing docs straight from VS Code.
• A better Markdown editor that make editing GitBook blocks easier.
• A better Preview for GitBook content, showing blocks as they'd be shown to your users.
• If you're using products that have their documentation on GitBook, we want you to be able to search those docs straight from VS Code.

If you have ideas for what you'd like our VS Code extension to do, please get in touch!