README.md
A complete overhaul of Minecraft's book system into a documentation platform.
Why it exists
Purpose
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.
Who it's for
Map makers, educators, server staff, storytellers, and developers who want rich in-game documentation.
Key capabilities
Markdown-powered books
A hand-written parser and renderer for Markdown in books.
Libraries & search
Index, organise, and search your written works.
Multiplayer sync
Share and synchronise books across players.
Export & themes
Export to Markdown, text, JSON, or HTML with custom themes.
Compatibility
Versions & loaders
| Property | Value |
|---|---|
| Loader / platform | Fabric |
| Latest version | r1.2 |
| 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 |
Stable across the 1.21.x series.
Version history
Changelog
r1.2
- Markdown engine
- Libraries and export
Roadmap
Where it's going
Markdown engine
doneLexer, parser, and renderer.
Authoring tools
nextEditor, undo/redo, and autosave.
Knowledge base
laterDeep library and search features.
FAQ
Questions, answered
Can I read normal books?
Is it client or server side?
Which versions?
Compatibility & limitations
What to know
Downloads
Get README.md
Ecosystem
