skill

Explain GitBook Markdown syntax, custom blocks, and configuration files.

51|81|Updated Oct 8, 2021
One-click install
npx skills add https://github.com/GitbookIO/public-docs --skill skill-gitbookio
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: skill
Source: https://github.com/GitbookIO/public-docs/tree/main
Command: npx skills add https://github.com/GitbookIO/public-docs --skill skill-gitbookio

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill provides comprehensive guidance on using GitBook's unique Markdown extensions, custom blocks, and configuration files, enabling efficient and accurate documentation creation.

Core Features & Use Cases

  • Markdown Syntax: Covers all standard and GitBook-specific Markdown formatting.
  • Custom Blocks: Explains the usage of blocks like tabs, hints, steppers, and more.
  • Configuration Files: Details the purpose and structure of .gitbook.yaml, SUMMARY.md, and .gitbook/vars.yaml.
  • Use Case: A technical writer needs to create a new guide using GitBook's stepper block for a multi-step process and wants to ensure all internal links are correctly formatted relative to the SUMMARY.md structure.

Quick Start

Use the skill to learn how to create a new page with a stepper block.

Frequently Asked Questions about skill

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

FAQPage Schema
How do I use custom blocks in GitBook markdown?

Custom blocks in GitBook markdown extend standard formatting with interactive elements like tabs, hints, and steppers. They help structure complex content such as multi-step processes directly within your documentation pages.

What is the purpose of the .gitbook.yaml configuration file?

The .gitbook.yaml configuration file manages your GitBook repository's structure and settings for Git-synced environments. It works alongside SUMMARY.md and .gitbook/vars.yaml to define navigation and variables for external editing.

Can I use frontmatter and variables in GitBook documentation?

Yes, GitBook supports frontmatter and variables to dynamically manage content. You can define custom variables in .gitbook/vars.yaml and use expressions within your markdown files to reuse values across pages.

How do I format internal links relative to SUMMARY.md in GitBook?

Internal links in GitBook must be formatted relative to the SUMMARY.md file structure. This ensures your documentation navigation remains intact when syncing through Git repositories and external editing environments.

What's the best way to structure multi-step content using GitBook blocks?

GitBook's stepper block is the recommended approach for multi-step content. It allows you to break down processes into sequential steps within a single page, improving readability for technical guides and tutorials.

Does GitBook markdown work with standard markdown syntax?

GitBook markdown supports all standard markdown formatting while adding custom blocks and extensions. This means standard syntax works alongside GitBook-specific features like tabs, hints, and steppers for enhanced documentation.