Install README.md #
Install Fabric Loader for 1.21 (plus Fabric API if the downloads page asks for it), place the JAR in your mods folder, and launch with the Fabric profile.
- 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.
Working with README.md #
Product-specific steps, separate from the general install guide above.
Book commands
Manage your in-game books from chat — README.md turns written books into a documentation platform with a live-preview Markdown editor:
- new — start a book from one of the 15 bundled templates.
- open <name> — open an existing work in the live-preview editor.
- save — persist the current draft.
- search <term> — search your indexed library.
- sync — multiplayer sync with MD5 change detection, roles and conflict resolution.
/readme new
/readme open <name>
/readme save
/readme search <term>
/readme syncWhat the Markdown engine renders
A hand-written lexer, parser and renderer turns written books into rich documents: **colors**, **==highlight==**, **||spoiler||**, **callouts**, **tables**, **task lists** and **syntax-highlighted code blocks**. Write Markdown in the editor and preview the rendered output live before saving.
What you'll see. The editor splits into a Markdown source pane and a rendered preview pane — ==highlights==, ||spoilers|| and callouts render as you type.
Themes & config
Both client and server read human-readable JSON configs in **config/** — themes included. **8 built-in themes** plus custom JSON themes let you restyle how books render. Existing vanilla books remain readable and upgradeable — nothing you have written is lost.
- Libraries & search — index, organise and search your written works.
- Export to Markdown, text, JSON or HTML, plus ZIP backups and batch conversion.
- A public API, EventBus and provider system let other mods extend README.md.
Tips
- 15 templates ship with the mod for common documentation layouts — start from one.
- Stable r1.2 across 1.21 → 1.21.11 (targets through 26.2).
- Export regularly — Markdown and HTML exports are the portable form of your library.
Common problems
Multiplayer sync conflicts
Old books look plain
Folder locations by platform #
| Platform | mods / resourcepacks folder | config folder |
|---|---|---|
| Windows | %appdata%\.minecraft\mods · \resourcepacks | %appdata%\.minecraft\config |
| macOS | ~/Library/Application Support/minecraft/mods | ~/Library/Application Support/minecraft/config |
| Linux | ~/.minecraft/mods · ~/.minecraft/resourcepacks | ~/.minecraft/config |
MultiMC / Prism users: these folders live inside Instances/<instance>/.minecraft/. Match the build to your exact Minecraft version — the compatibility table in the docs lists every supported version.
Configure #
Settings live in the config folder (JSON5 files you can edit by hand) and, where available, in the in-game settings screen the mod adds. The exact keys and keybinds are listed in the documentation and the FAQ below.
Tips for README.md #
- Keep README.md on the version range shown on its product page.
- If it doesn't load, confirm the JAR is in the right mods folder for the launcher and version you chose.
- Bedrock Edition, mobile, and console can't run Java Edition mods or packs — for a port or custom variant, request a commission.