Overview #
README.md is a complete overhaul of Minecraft's book system, turning written books into powerful interactive documentation tools. A hand-written Markdown lexer, parser and renderer turns books into rich documents: colors, ==highlight==, ||spoiler||, callouts, tables, task lists and syntax-highlighted code blocks — written in a live-preview editor where you see the rendered output as you type. It adds libraries and search (index, organise and search your written works), export to Markdown, text, JSON or HTML with ZIP backups and batch conversion, 15 templates for common documentation layouts, 8 built-in themes plus custom JSON themes, and multiplayer sync with MD5 change detection, roles and conflict resolution. Existing vanilla books remain readable and upgradeable. A public API, EventBus and provider system let other mods extend it.
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 (stable r1.2 across 1.21 → 1.21.11; targets through 26.2) — install it server-side too for multiplayer sync.
- Start a book with /readme new — pick from one of the 15 bundled templates or begin from scratch.
- Write Markdown in the live-preview editor and see the rendered output as you type: ==highlights==, ||spoilers||, callouts, tables, task lists and syntax-highlighted code blocks.
- Manage books from chat: /readme open <name>, /readme save, /readme search <term>.
- Organise works into a library and search them; restyle with 8 built-in themes or a custom JSON theme.
- Export to Markdown, text, JSON or HTML, or run ZIP backups and batch conversion.
- For multiplayer, install on both client and server and use /readme sync — MD5 change detection, roles and conflict resolution keep books consistent.
Configuration #
Both client and server read human-readable JSON configs in config/ — themes included. Edit while the game is closed.
| Setting | Default | Description |
|---|---|---|
| Themes | 8 built-in | Built-in themes plus custom JSON themes control how books render. |
| Templates | 15 bundled | Templates for common documentation layouts, used when starting a new book. |
| Multiplayer sync | Configured per side | Client + server sync with MD5 change detection, roles and conflict resolution. |
| Export formats | Markdown, text, JSON, HTML | Plus ZIP backups and batch conversion. |
Frequently asked questions #
Can I read normal books?
Is it client or server side?
What Markdown does it support?
Can I theme my books?
What can I import/export?
Can other mods extend it?
How do I edit a book?
What formatting is available?
How does multiplayer sync work?
Where are my books stored?
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.