Overview #
README.md is a complete overhaul of Minecraft's book system, turning books into powerful interactive documentation tools.
Written books in Minecraft are text dumps. README.md transforms them into a powerful, interactive documentation tool — Markdown rendering, theming, libraries, search, and export — for documentation, education, storytelling, and developer content.
Quick start #
- Install the mod for your Minecraft version.
- Write Markdown into a book using the editor.
- Preview rendered output and organise into a library.
- Export or sync books as needed.
Frequently asked questions #
Can I read normal books?
Yes — existing books remain readable and upgradeable.
Is it client or server side?
Multiplayer sync makes it valuable on both.
Which versions?
1.21 through 1.21.11.
Compatibility #
| Property | Value |
|---|---|
| Loader / platform | Fabric |
| Minecraft versions | 1.21, 1.21.1, 1.21.2, 1.21.3, 1.21.4, 1.21.5, 1.21.6, 1.21.7, 1.21.8, 1.21.9, 1.21.10, 1.21.11 |
| Latest version | r1.2 |
Stable across the 1.21.x series.