Guides

Explore guides for creating and structuring documentation in GitBook

GitBook’s editor makes it easy to create and customize documentation, whether you’re starting fresh or working in an existing space.

Explore

How to use GitBook’s editor

Create pages, add content blocks, and publish documentation

Import content from a CSV file

Import documentation from Zendesk or another CSV export

Embed a playable video

Add video content directly to your documentation

Make batch changes with Git Sync

Update repeated content across your documentation from a code editor

Quick guides

How do I structure my documentation?

Organize pages and groups around the tasks readers need to complete.

This guide covers planning page hierarchy, creating groups, and refining navigation.

How do I reuse content across pages?

Reusable content keeps shared text consistent across your documentation.

This guide covers creating reusable blocks, inserting them into pages, and updating shared content.

How do I manage repeated values with variables?

Variables let you define a value once and reuse it across your content.

This guide covers creating variables, referencing them in pages, and maintaining shared values.

How do I create a documentation style guide?

A style guide keeps your documentation consistent across contributors and AI-assisted changes.

This guide covers defining writing rules, adding terminology guidance, and maintaining the guide.