Overview #
README.md is a complete overhaul of Minecraft's book system, turning written books into powerful interactive documentation tools. Markdown rendering, theming, libraries, search, and export make it the most complete documentation product in the ecosystem.
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 the rendered output live.
- Organise works into a library and search them.
- Export to Markdown, text, JSON, or HTML, or sync with other players.
Frequently asked questions #
Can I read normal books?
Yes — existing books remain readable and upgradeable.
Is it client or server side?
Both — multiplayer sync with MD5 change detection, roles and conflict resolution.
What Markdown does it support?
Rich formatting, colors, ==highlight==, ||spoiler||, callouts, tables, task lists and syntax-highlighted code blocks.
Can I theme my books?
Yes — 8 built-in themes plus custom JSON themes.
What can I import/export?
Markdown, text, JSON and HTML, plus ZIP backups and batch conversion.
Can other mods extend it?
Yes — it ships a public API, EventBus and provider system, plus 15 templates.
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.
Learn more. Step-by-step walkthroughs live in the tutorials,
with install guides for every platform and a general
guide to configuration. Still stuck? Open the
support portal and we'll reply from support@herostudios.dev.