ModsFinder

Markdown Manual

by Sangar

Markdown Manual is a Sangar library for creating in-game manuals, written in Markdown and shown in a book-style screen for players to read.

FabricForgeNeoForgeClient and serverMIT LicenseOpen source1.18.2 – 1.21.11

What it does

Manuals are defined as Markdown documents that can link to one another, and images are embedded with Markdown-style image references pointing at blocks or items. A mod registers its own manual with the manuals registry, then makes it available to players, typically through a registered item that opens the document.

The library is aimed at mod developers who want to ship documentation inside the game instead of in an external wiki. TIS-3D is cited by the author as an example of a mod that uses an in-game manual built on this library. Required setup code is described in the Manuals class, and content definitions are documented in the doc directory of the source.

Markdown Manual runs on client and server, so the server and every player need it. It is published for Fabric, Forge and NeoForge, with builds covering 1.18.2 – 1.21.11, and requires Architectury API and Fabric API. The code is open source under the MIT License.

Key features

  1. In-game manual screen

    Players open a manual as a readable screen, with pages rendered from Markdown documents.

  2. Linked documents

    Content documents can reference other content documents, so a manual can be organized as a set of connected pages.

  3. Embedded images

    Blocks and items can be shown inside a page through Markdown-style image references.

  4. Adjustable styling

    The default manual UI can be restyled, and the author provides screenshots of three skins applied to the same content.

Compatibility

Latest build for each game version and loader.

1.21.x2 of 2 versions with builds
1.21.11MC1.21.11-fabric-1.2.7Not availableMC1.21.11-neoforge-1.2.7
1.21.1MC1.21.1-fabric-1.2.8Not availableMC1.21.1-neoforge-1.2.8
1.20.x3 of 3 versions with builds
1.20.4MC1.20.4-fabric-1.2.6MC1.20.4-forge-1.2.6MC1.20.4-neoforge-1.2.6
1.20.2MC1.20.2-fabric-1.2.6MC1.20.2-forge-1.2.6Not available
1.20.1MC1.20.1-fabric-1.2.5MC1.20.1-forge-1.2.5Not available
1.19.x3 of 3 versions with builds
1.19.3MC1.19.3-fabric-1.2.3MC1.19.3-forge-1.2.3Not available
1.19.2MC1.19.2-fabric-1.2.3MC1.19.2-forge-1.2.3Not available
1.19Not availableMC1.19-forge-1.2.2Not available
1.18.x1 of 1 version with builds
1.18.2Not availableMC1.18.2-forge-1.2.1Not available
ReleaseBetaAlphaNot available

Only full game releases are shown. This mod publishes no snapshot builds.

Requirements

Dependencies declared by the latest file for each loader.

Required 2

Fabric APILightweight and modular API providing common hooks and intercompatibility measures utilized by mods using the Fabric toolchain.
Required
Architectury APIAn intermediary api aimed to ease developing multiplatform mods.
Required

Required by 6 mods

TIS-3D1.18.2 – 1.21.11OpenComputers 2: Reimagined1.20.1OpenComputers II1.21.1OC2R: Components1.20.1OC2R: Valkyrien Skies1.20.1OC2R: Library1.20.1

Use cases

Mod documentation

A mod author can explain its blocks, items and recipes in a manual the player reads without leaving the game.

Modpack guides

Pack authors can add a guide that travels with the modpack and covers its custom content.

Who it’s for: Mod developers who want to add documentation to their mods, and pack authors who want an in-game guide for custom content.

How it compares

Full comparison

SinoCore is a Fabric, Forge and NeoForge library for 1.20.1 – 1.21.1 under a custom license that is not open source. Modonomicon covers 1.18.2 – 26.3 for the same three loaders and uses the MIT AND CC-BY-4.0 license, also not open source. JRAPI is open source under the MIT License for 1.20.2 – 1.20.4 on the same three loaders, with a narrower version range than Markdown Manual.

ModLoadersGame versionsEnvironmentUpdated
Markdown ManualFabric, Forge and NeoForge1.18.2 – 1.21.11Client and server2026-09-24
SinoCoreFabric, Forge and NeoForge1.20.1 – 1.21.1Client and server2026-01-02
ModonomiconFabric, Forge and NeoForge1.18.2 – 26.3Client and server2026-10-13
JRAPIFabric, Forge and NeoForge1.20.2 – 1.20.4Client and server2024-04-21

Questions

Does Markdown Manual need Architectury API?

Yes. Architectury API is listed as a required dependency, and Fabric API is required as well, so both must be installed alongside it.

Does the server need Markdown Manual?

Yes. The server and every player need the mod installed.

Which game versions have Markdown Manual files?

Files exist for 1.18.2, 1.19, 1.19.2, 1.19.3, 1.20.1, 1.20.2, 1.20.4, 1.21.1 and 1.21.11.

In the catalog

Markdown Manual is one of 3,514 Library mods on ModsFinder, and one of 2,348 Library mods for Fabric. 19,862 mods support Minecraft 1.21.11.

Library mods3,514Fabric modsMods for 1.21.1119,862

More from Sangar

All projects
Scannable1.18.2 – 1.21.11OpenComputers1.7.10 – 1.12.2TIS-3D1.18.2 – 1.21.11Bedrock Ores1.19.2 – 1.21.11OpenComputers II1.21.1

Similar mods

Fabric API1.14 – 26.3Cloth Config API1.14 – 26.3YetAnotherConfigLib (YACL)1.19 – 26.3Architectury API1.16.5 – 26.3Just Enough Items (JEI)1.8 – 26.3Geckolib1.12.2 – 26.3

What the author says

MarkdownManual is a library mod enabling in-game manuals with content defined in Markdown documents. It is intended to be used by mod developers to provide in-game documentation of their mods in a simple manner. The mod provides a simple default manual look, but can be re-styled easily, or completely embedded into…
Sangar, on the Modrinth page

Official listing

Owner
Sangar
Published
2022-05-20
Updated on Modrinth
2026-09-24
Facts verified
2026-10-15

Tags

Library
Open on ModrinthCompare