Welcome
Aozora Flavored Markdown (afm) is a Markdown dialect that layers
Aozora Bunko (青空文庫) typography — ruby, bouten, 縦中横, ［＃…］
annotations, gaiji, accent decomposition — on top of CommonMark + GFM
for Japanese vertical and horizontal writing.
Like GFM, afm is a strict superset of its base: any pure
CommonMark or GFM document parses identically under afm, and the
Aozora extensions kick in only where the input actually uses them.
The file extension remains .md.
This handbook is both a practical tour and a reference:
- Tour — install the CLI, try the CLI Quickstart, embed the library.
- Reference — walk the parse pipeline, read the architectural decisions, browse the CLI reference and API reference.
Status
100% CommonMark / GFM spec compatibility, all major Aozora Bunko annotations implemented, with a 96% regions coverage floor.
See the project README for an at-a-glance summary and the CHANGELOG for release history.