format-md

Formats .md and .mdx files using @takazudo/mdx-formatter, preserving JSX and YAML frontmatter.

11|1|Updated Feb 10, 2026
One-click install
npx skills add https://github.com/Takazudo/claude-resources --skill format-md
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: format-md
Source: https://github.com/Takazudo/claude-resources/tree/main/skills/format-md
Command: npx skills add https://github.com/Takazudo/claude-resources --skill format-md

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This tool standardizes Markdown and MDX files by applying consistent formatting across a project, ensuring readable, uniform documentation.

Core Features & Use Cases

  • MDX/Markdown formatting: formats .md and .mdx files using the @takazudo/mdx-formatter, preserving JSX and imports/exports.
  • Batch and single-file support: formats a single file, multiple files, or glob patterns such as docs/**/*.md.
  • Real-world example: standardize a docs folder before release to ensure consistent headings, lists, and code blocks.

Quick Start

Run the formatter on a path or pattern to rewrite the target Markdown/MDX files.

Frequently Asked Questions about format-md

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

FAQPage Schema
How do I format Markdown and MDX files across an entire project consistently?

Format Markdown and MDX files across a project by applying a glob pattern like docs/**/*.md to standardize headings, lists, and code blocks in a single command. This rewrites target files to ensure uniform, readable documentation.

Does the MDX formatter preserve JSX syntax and imports during formatting?

Yes, formatting MDX files preserves JSX syntax, imports, and exports. It also retains Docusaurus admonitions and GFM features while applying consistent styling to surrounding text.

What is the best way to standardize a documentation folder before a release?

Standardize a docs folder before release by running the formatter on the directory or a glob pattern. This ensures consistent headings, lists, and code blocks across all Markdown and MDX files.

Can I use this Markdown formatting approach in CI workflows?

Yes, you can format Markdown and MDX files in CI workflows. Running the formatter on targeted paths or patterns ensures documentation remains consistently styled across automated builds.

Do I need an npm package to format MDX files with this method?

Yes, formatting MDX files requires the npm package @takazudo/mdx-formatter. This dependency provides the underlying engine to parse and rewrite styling of your Markdown content.