# mdx-formatter

> AST-based markdown and MDX formatter

## Docs

- [Architecture Overview](/pj/mdx-formatter/docs/architecture): Architecture Overview
- [Changelog](/pj/mdx-formatter/docs/changelog): Release notes and version history for mdx-formatter.
- [Formatting Rules](/pj/mdx-formatter/docs/formatting): How mdx-formatter formats each type of markdown/MDX content
- [Options](/pj/mdx-formatter/docs/options): All configurable options for mdx-formatter
- [Overview](/pj/mdx-formatter/docs/overview): AST-based markdown and MDX formatter with Japanese text support
- [Playground](/pj/mdx-formatter/docs/playground): Interactive formatter playground — paste markdown and see the formatted output
- [Rust Engine](/pj/mdx-formatter/docs/architecture/rust-rewrite): Rust Engine
- [/CLAUDE.md](/pj/mdx-formatter/docs/claude-md/root): CLAUDE.md at /CLAUDE.md
- [Headings](/pj/mdx-formatter/docs/formatting/headings): How the formatter normalizes heading styles and spacing
- [addEmptyLineBetweenElements](/pj/mdx-formatter/docs/options/add-empty-line-between-elements): Add empty lines between markdown block elements
- [Installation](/pj/mdx-formatter/docs/overview/installation): How to install @takazudo/mdx-formatter
- [Rust Crate](/pj/mdx-formatter/docs/architecture/rust-crate): Using mdx-formatter-core as a Rust library
- [Testing Strategy](/pj/mdx-formatter/docs/architecture/testing-strategy): Testing Strategy
- [/crates/CLAUDE.md](/pj/mdx-formatter/docs/claude-md/crates): CLAUDE.md at /crates/CLAUDE.md
- [Lists](/pj/mdx-formatter/docs/formatting/lists): How the formatter normalizes list indentation and spacing
- [formatMultiLineJsx](/pj/mdx-formatter/docs/options/format-multi-line-jsx): Format multi-line JSX/HTML components with proper indentation
- [Usage](/pj/mdx-formatter/docs/overview/usage): CLI and API usage for mdx-formatter
- [/doc/CLAUDE.md](/pj/mdx-formatter/docs/claude-md/doc): CLAUDE.md at /doc/CLAUDE.md
- [Code Blocks](/pj/mdx-formatter/docs/formatting/code-blocks): How the formatter handles fenced code blocks
- [formatHtmlBlocksInMdx](/pj/mdx-formatter/docs/options/format-html-blocks-in-mdx): Format HTML blocks within MDX content with proper indentation
- [Configuration](/pj/mdx-formatter/docs/overview/configuration): Configuration options and config file setup for mdx-formatter
- [/src/CLAUDE.md](/pj/mdx-formatter/docs/claude-md/src): CLAUDE.md at /src/CLAUDE.md
- [Tables](/pj/mdx-formatter/docs/formatting/tables): How the formatter handles GFM tables and HTML tables
- [expandSingleLineJsx](/pj/mdx-formatter/docs/options/expand-single-line-jsx): Convert single-line JSX components with multiple props to multi-line format
- [/test/CLAUDE.md](/pj/mdx-formatter/docs/claude-md/test): CLAUDE.md at /test/CLAUDE.md
- [Japanese Text](/pj/mdx-formatter/docs/formatting/japanese-text): Special handling for Japanese (CJK) text formatting
- [indentJsxContent](/pj/mdx-formatter/docs/options/indent-jsx-content): Add indentation to content inside JSX container components
- [MDX / JSX](/pj/mdx-formatter/docs/formatting/mdx-jsx): How the formatter handles MDX-specific syntax and JSX components
- [addEmptyLinesInBlockJsx](/pj/mdx-formatter/docs/options/add-empty-lines-in-block-jsx): Add empty lines in block JSX components for better readability
- [API Reference](/pj/mdx-formatter/docs/overview/api): CLI options and programmatic API reference for mdx-formatter
- [HTML Blocks](/pj/mdx-formatter/docs/formatting/html-blocks): How the formatter indents HTML blocks within MDX content
- [formatYamlFrontmatter](/pj/mdx-formatter/docs/options/format-yaml-frontmatter): Format YAML frontmatter using proper YAML formatting rules
- [Browser Usage](/pj/mdx-formatter/docs/overview/browser-usage): Using mdx-formatter in browser environments via WASM
- [Contribution](/pj/mdx-formatter/docs/overview/contribution): Contribution guidelines and project background
- [Docusaurus Admonitions](/pj/mdx-formatter/docs/formatting/docusaurus-admonitions): How the formatter preserves Docusaurus admonition syntax
- [preserveAdmonitions](/pj/mdx-formatter/docs/options/preserve-admonitions): Keep Docusaurus admonitions intact during formatting
- [autoDetectIndent](/pj/mdx-formatter/docs/options/auto-detect-indent): Automatically detect indentation style from file content
- [errorHandling](/pj/mdx-formatter/docs/options/error-handling): Configure how the formatter handles parsing errors
- [v0.1.0](/pj/mdx-formatter/docs/changelog/v0.1.0): v0.1.0
- [v0.1.1](/pj/mdx-formatter/docs/changelog/v0.1.1): v0.1.1
- [v0.1.2](/pj/mdx-formatter/docs/changelog/v0.1.2): v0.1.2
- [v0.2.0](/pj/mdx-formatter/docs/changelog/v0.2.0): v0.2.0
- [v0.2.1](/pj/mdx-formatter/docs/changelog/v0.2.1): v0.2.1
- [v0.3.0](/pj/mdx-formatter/docs/changelog/v0.3.0): v0.3.0
- [v0.4.0](/pj/mdx-formatter/docs/changelog/v0.4.0): v0.4.0
- [v0.4.1](/pj/mdx-formatter/docs/changelog/v0.4.1): v0.4.1
- [v0.4.2](/pj/mdx-formatter/docs/changelog/v0.4.2): v0.4.2
- [v0.4.3](/pj/mdx-formatter/docs/changelog/v0.4.3): v0.4.3
- [Claude](/pj/mdx-formatter/docs/claude): Claude Code configuration reference.
- [v1.0.0](/pj/mdx-formatter/docs/changelog/v1.0.0): v1.0.0
- [l-design-system](/pj/mdx-formatter/docs/claude-skills/l-design-system): Design system reference for the mdx-formatter doc site (zudo-doc based). Use PROACTIVELY when: (1) Writing or modifying any CSS/styling in doc/, (2) Creating or editing React components in doc/src/com...
- [l-version-increment](/pj/mdx-formatter/docs/claude-skills/l-version-increment): Bump package version, generate changelog doc, tag, and publish to npm
- [l-version-next](/pj/mdx-formatter/docs/claude-skills/l-version-next): Publish a prerelease version under the npm "next" dist-tag
- [l-version-promote](/pj/mdx-formatter/docs/claude-skills/l-version-promote): Promote a next prerelease to a stable release