gitbook-format

Converts and repairs GitBook block syntax and link aliases in MariaDB documentation Markdown files.

28|115|Updated Jan 28, 2025
One-click install
npx skills add https://github.com/mariadb-corporation/mariadb-docs --skill gitbook-format-mariadb-corporation
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: gitbook-format
Source: https://github.com/mariadb-corporation/mariadb-docs/tree/main/.claude/skills/gitbook-format
Command: npx skills add https://github.com/mariadb-corporation/mariadb-docs --skill gitbook-format-mariadb-corporation

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? MariaDB documentation pages often contain plain-Markdown substitutes, broken GitBook blocks, or raw cross-space URLs that render incorrectly in GitBook. This Skill converts prose notes, parallel content, and code samples into correct GitBook-flavored Markdown and fixes unbalanced blocks without touching code examples. ## Core Features & Use Cases - Callouts and Tabs: Converts prose notes into {% hint %} blocks with the four valid styles (info, warning, danger, success) and turns platform-parallel content into {% tabs %} structures. - Code Blocks, Content-Refs, and Includes: Wraps fenced code in titled {% code %} blocks when useful, builds {% content-ref %} page cards, and manages reusable or file-based {% include %} directives with correct relative path depth. - Link Conversion and Block Repair: Converts raw GitBook URLs into cross-space {alias} links, fixes invalid hint styles, and repairs unbalanced block openers and closers. - Use Case: A contributor asks to "make this a warning box and convert these links to aliases" on a server docs page; the Skill rewrites the admonition as {% hint style="warning" %}, swaps hard-coded URLs for {maxscale}-style aliases, and leaves all SQL code samples untouched. ## Quick Start Ask the AI to fix the GitBook formatting on a specific MariaDB docs page, converting notes into hint blocks and raw URLs into alias links.

Frequently Asked Questions about gitbook-format

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

FAQPage Schema
How do I add a warning or note callout in GitBook Markdown?▼

Wrap the content in a hint block: `{% hint style="warning" %}` followed by the text and `{% endhint %}`. Only four styles are valid: info for notes, warning for cautions, danger for destructive actions, and success for confirmations.

How to convert cross-space GitBook URLs to alias links?▼

Replace raw `https://app.gitbook.com/...` URLs with the alias form `[Text]({space-alias}/path)`, using the alias table in dev-docs/link-aliases.md. Never expand an existing `{alias}` back into a URL, since the CI Action handles expansion.

Does GitBook formatting apply inside fenced code blocks?▼

No. Content inside fenced code blocks or `{% code %}` blocks must be treated as opaque and never modified, because SQL, JSON, and config samples legitimately contain `{%`-like fragments and raw URLs that are examples, not syntax to fix.

Why does a GitBook file include render as empty content?▼

An empty include usually means the `../` prefix count is wrong: it needs one `..` per directory between the page and its space root. It also fails if the path climbs into a sibling space, since file includes must stay within the page's own space.

When should I use a reusable include versus a file include in GitBook?▼

Use a reusable-content include (by ID) only when copying an existing directive verbatim from a sibling page, since those blocks are created in the GitBook UI. Use a file include for snippets you create yourself in the space's `.gitbook/includes/` directory.