skills.rest
SARAMALI15792
SARAMALI15792COMMUNITY
Explore all skills by this author →
GitHub

docusaurus-conventions

Enforce Docusaurus file naming, frontmatter, and ID conventions for MDX docs.

7|1|Updated Feb 14, 2026
Search Tags:#documentation#markdown#frontmatter#docusaurus#md#docs-structure
One-click install
npx skills add https://github.com/SARAMALI15792/AINativeBook --skill docusaurus-conventions-saramali15792
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: docusaurus-conventions
Source: https://github.com/SARAMALI15792/AINativeBook/tree/main/.qwen/skills/docusaurus-conventions
Command: npx skills add https://github.com/SARAMALI15792/AINativeBook --skill docusaurus-conventions-saramali15792

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Docusaurus conventions for file naming, syntax, and structure help RoboLearn teams build consistent, error-free docs.

Core Features & Use Cases

  • Enforces file naming patterns (NN-descriptive-name.md), README usage, and required frontmatter to keep docs navigable.
  • Guides MDX safety, internal linking, and chapter/module layout to prevent broken links and ID collisions.
  • Supports build-ready workflows through pre-flight guidelines and recovery patterns.

Quick Start

Review and apply the Docusaurus conventions to ensure documents use the correct file naming, IDs, and chapter structure for reliable builds.

Frequently Asked Questions about docusaurus-conventions

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

FAQPage Schema
Why does my Docusaurus build fail with ID collisions and broken links?▼

Docusaurus builds fail when MDX content has duplicate IDs or invalid internal links. Enforcing unique IDs, proper frontmatter, and file naming conventions prevents these structural errors.

What frontmatter is required in Docusaurus markdown files to ensure builds?▼

Docusaurus markdown files require frontmatter with a name and description to ensure builds. Maintaining this standard across all docs keeps content navigable and error-free.

How do I structure Docusaurus files and chapters to prevent broken links?▼

Structure Docusaurus files using NN-descriptive-name.md patterns and README usage. This chapter and module layout maintains unique IDs and prevents broken links during builds.

How do I write safe MDX content for Docusaurus without build errors?▼

Write safe MDX content by following Docusaurus safety guidelines for internal linking and module layout. This prevents syntax errors and ensures reliable, build-ready documentation.

Do I need to follow specific file naming patterns for Docusaurus markdown?▼

Yes, Docusaurus requires file naming patterns like NN-descriptive-name.md. Applying these conventions ensures documents use correct IDs and structure for reliable builds.

Related Skills

Explore More Content & Communication Skills→
safzanpiranisafzanpirani
1

writing-shape

Shapes raw markdown notes into structured articles through iterative editing conversations.

Community
Intermediate
CenredJunCenredJun

site-reliability-engineer

Validate Docusaurus MDX syntax and site builds for CI deployment gates.

Community
Advanced
lbliiilbliii
41

bengal-content-migration

Migrates static site and Markdown content to Bengal format.

Community
Intermediate
leaderiopleaderiop
7

Documentation Docusaurus

Enforce Docusaurus coding standards across MDX/Markdown content, configuration, and navigation.

Community
Intermediate