The State of Docs Report 2025 is live! Dive in and see why docs matter more than ever:
Read the report
LogoLogo
ProductPricingLog inSign up
  • Documentation
  • Developers
  • Guides
  • Changelog
  • Help Center
  • Getting Started
    • GitBook Documentation
    • Quickstart
    • Importing content
    • GitHub & GitLab Sync
      • Enabling GitHub Sync
      • Enabling GitLab Sync
      • Content configuration
      • GitHub pull request preview
      • Commit messages & Autolink
      • Monorepos
      • Troubleshooting
  • Creating Content
    • Formatting your content
      • Inline content
      • Markdown
    • Content structure
      • Spaces
      • Pages
      • Collections
    • Blocks
      • Paragraphs
      • Headings
      • Unordered lists
      • Ordered lists
      • Task lists
      • Hints
      • Quotes
      • Code blocks
      • Files
      • Images
      • Embedded URLs
      • Tables
      • Cards
      • Tabs
      • Expandable
      • Stepper
      • Drawings
      • Math & TeX
      • Page links
    • Reusable content
    • Broken links
    • Searching content
      • Search & Quick find
      • GitBook AI
    • Writing with GitBook AI
    • Version control
  • API References
    • OpenAPI
      • Add an OpenAPI specification
      • Insert API reference in your docs
    • Guides
      • Structuring your API reference
      • Adding custom code samples
      • Managing API operations
      • Describing enums
      • Integrating with CI/CD
  • Extensions reference
  • Publishing Documentation
    • Publish a docs site
      • Public publishing
      • Private publishing with share links
    • Site structure
      • Content variants
      • Site sections
    • Site customization
      • Icons, colors, and themes
      • Layout and structure
      • Extra configuration
    • Set a custom domain
    • Setting a custom subdirectory
      • Configuring a subdirectory with Cloudflare
      • Configuring a subdirectory with Vercel
    • Site settings
    • Site insights
    • Site redirects
    • Visitor authentication
      • Enabling visitor authentication
      • Setting up Auth0
      • Setting up Azure AD
      • Setting up AWS Cognito
      • Setting up Okta
      • Setting up OIDC
      • Setting up a custom backend
  • LLM-ready docs
  • Collaboration
    • Live edits
    • Change requests
    • PDF export
    • Inviting your team
    • Comments
    • Notifications
  • Integrations
    • Install and manage integrations
    • GitHub Copilot
  • Account management
    • Plans
      • Legacy pricing
      • Sponsored site plan
      • Non-profit plan
      • Billing policy
    • Subscription cancellations
    • Personal settings
    • Organization settings
    • Member management
      • Invite or remove members
      • Roles
      • Teams
      • Permissions and inheritance
    • SSO & SAML
      • SSO Members vs non-SSO
  • Resources
    • GitBook UI
    • Keyboard shortcuts
    • Glossary
Powered by GitBook
LogoLogo

Resources

  • Showcase
  • Enterprise
  • Status

Company

  • Careers
  • Blog
  • Community

Policies

  • Subprocessors
  • Terms of Service
On this page
  • Product Demo
  • Create a snippet
  • Edit a snippet
  • Share a snippet
  • Convert a snippet to a page
  • Delete a snippet

Was this helpful?

Edit on GitHub
  1. Snippets

Snippets (beta)

Add snippets of knowledge from your favorite tools, and GitBook AI will turn them into something useful

Last updated 1 month ago

Was this helpful?

The Snippets feature is no longer maintained in GitBook and is subject to change. We recommend to structure your content in a instead.

This feature is available as part of the Pro plan and Enterprise plan. To find out more, .

In GitBook, you can capture unstructured information using , and GitBook AI will turn it into a snippet — a structured page of information that’s easy to read and digest. You can also create snippets manually within the app.

GitBook will index all of your snippets alongside the rest of your content and can reference them when you or your team . You can also merge snippets into existing docs or content to keep everything up to date.

Product Demo

Create a snippet

You can create snippets in GitBook in different ways, depending on the tool you’re using or the workspace you’re in.

Create a snippet from a third-party tool

Every snippet you add to your organization will end up in the Snippets page, along with information about it — such as its source, author, and when it was created.

Create a snippet manually

You can create a snippet manually from the Snippets page, by clicking the Create your own card. A blank page will appear and you can add any information you’d like.

Edit a snippet

You can edit a snippet you’ve captured by clicking to open it from the Snippets page. This will open an editor view, where you can edit any information that might be wrong, or add additional context for things that might be missing.

Share a snippet

You can share a snippet with others as a direct link to the organization it’s in. When viewing a snippet, you’ll find the Copy link button in the top-right corner.

Convert a snippet to a page

You can convert a snippet to a full page within your documentation. To do this, open a snippet and choose Convert to page in the top-right corner.

Delete a snippet

A snippet is permanently deleted when you discard it.

You can capture snippets from third-party tools using integrations. Depending on the tool you’re using, you can add snippets in different ways. Find out more about capturing snippets in third-party tools in .

You’ll be prompted to choose a space for your page — you can use the drop-down menu to search for a space or scroll. When you select a space, GitBook will add the content of the snippet as a new page, or if you select a space .

Note: When you convert a snippet to the page, GitBook will automatically archive the snippet. If you’ve linked to the snippet using or , the links will still work but will take readers to the original snippet, not the new page.

To delete a snippet, open it by clicking it in the Snippets page, then click the Discard option from the Action menu in the upper right corner.

the integrations section
open a change request
with locked live edits
space
visit our pricing page
integrations
searches for information
a snippet block
an inline link
Snippets Product Demo