gitbook

Edit GitBook content in Git repositories using frontmatter and block syntax.

2|16|Updated Jun 25, 2018
One-click install
npx skills add https://github.com/ivvycode/apidocs --skill gitbook-ivvycode
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: gitbook
Source: https://github.com/ivvycode/apidocs/tree/main
Command: npx skills add https://github.com/ivvycode/apidocs --skill gitbook-ivvycode

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This GitBook editing skill helps teams maintain accurate, well-structured documentation by providing a clear, repeatable approach to authoring content outside the GitBook UI, including frontmatter, blocks, and reusable components.

Core Features & Use Cases

  • Centralizes GitBook authoring in text editors and IDEs
  • Documents frontmatter fields, blocks, and layout metadata
  • Supports working with SUMMARY.md, .gitbook.yaml, and the .gitbook directory structure

Quick Start

Open your GitBook space in a text editor and begin editing markdown files following the frontmatter and blocks conventions.

Frequently Asked Questions about gitbook

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I edit GitBook content and blocks outside the UI?

To edit GitBook content outside the UI, modify markdown files in a text editor by applying frontmatter conventions and block syntax for pages, spaces, and reusable blocks.

What frontmatter fields are supported for GitBook markdown files?

Supported GitBook frontmatter fields include description, icon, hidden, vars, and layout, which define page metadata and structure when authoring documentation outside the UI.

How do I configure GitBook spaces using SUMMARY.md and .gitbook.yaml?

Configure GitBook spaces by defining navigation and structure through SUMMARY.md, while managing space configuration and integration settings via the .gitbook.yaml file.

Can I use text editors and IDE workflows to manage GitBook reusable blocks?

Yes, you can manage GitBook reusable blocks within local IDE workflows by editing the .gitbook directory structure and referencing shared content via assets/includes/vars.yaml.

What is the best way to structure GitBook documentation in a Git repository?

The best way to structure GitBook documentation in a Git repository is to organize markdown pages, configure the .gitbook.yaml file, and maintain the SUMMARY.md hierarchy.

Why are my GitBook blocks not rendering when I edit markdown locally?

GitBook blocks like tabs, stepper, hint, details, and columns may not render if the syntax is incorrect or if the .gitbook directory structure and layout configurations are improperly applied.