new-page

Scaffolds MariaDB documentation pages with frontmatter, GitBook syntax, and SUMMARY.md navigation entries.

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

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Creating a new MariaDB documentation page involves many easy-to-miss conventions: correct frontmatter, house style, GitBook block syntax, file naming rules, and a SUMMARY.md nav entry without which the page never appears in the published docs. This Skill walks through the entire process so the new page is publishable as-is. ## Core Features & Use Cases - Correct placement and naming: Chooses the right space and subdirectory, enforces kebab-case naming (preserving underscores for identifiers), and uses README.md for section landing pages. - House style and GitBook syntax: Generates pages with description frontmatter, American English, sentence-style headings, and valid hint/tabs/code/content-ref blocks, plus proper relative and cross-space alias links. - SUMMARY.md nav integration: Adds the navigation entry in the correct location with matching indentation style, then validates the result with the doc-lint hook. - Use Case: A contributor asks to "add a docs page about configuring the binary log under server". The Skill confirms the space and location, creates server/reference/.../configuring-the-binary-log.md with proper frontmatter, adds the SUMMARY.md entry, and runs the linter. ## Quick Start Ask the assistant to create a new documentation page about your topic in a specific MariaDB docs space, for example: "Create a new page about connector timeouts under the connectors space."

Frequently Asked Questions about new-page

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

FAQPage Schema
How do I create a new MariaDB documentation page?▼

Provide the topic, target space (server, maxscale, connectors, etc.), and desired location. The Skill creates the Markdown file with description frontmatter and house style, adds a SUMMARY.md nav entry, and validates the result with the doc-lint hook.

Why doesn't my new GitBook page appear in the navigation?▼

A page without a SUMMARY.md entry will not appear in the published nav. You must add a `* [Title](path/to/file.md)` entry in the space's SUMMARY.md, matching the surrounding two-space indentation style.

What file naming convention does MariaDB docs use for new pages?▼

Leaf pages use kebab-case .md names, but underscores are preserved when the name is an identifier such as a system variable or tool (e.g. my_print_defaults.md). Section landing pages must be named README.md, which GitBook treats as the directory's page.

Can I create pages in the .gitbook/includes or help-tables directories?▼

No. The .gitbook/includes directory holds reusable include snippets only, and help-tables is generated content. Standalone pages must live in the appropriate subdirectory of a documentation space.

How do cross-space links work in MariaDB GitBook docs?▼

Same-space links use relative .md paths, while cross-space links use {alias}/path aliases defined in the link-aliases reference. Raw app.gitbook.com URLs must never be pasted into pages, except for cross-space reusable include directives.