ModsFinder

Markdown Manual: Renewed

by ewoudje

Markdown Manual: Renewed is a NeoForge library that lets mods present in-game manuals written as Markdown documents.

NeoForgeClient required, server optionalMIT LicenseOpen source1.21.1

What it does

The library is a renewed, ported version of the earlier manual library for NeoForge 1.21.1. Manuals are defined as Markdown documents and registered through a manuals registry, after which a mod can attach a manual to an item and make it available to players. Documents may link to other content documents, and images from blocks and items can be embedded with Markdown-style image references.

Because it is a library, the mod has no standalone function for players. Required setup code lives in the Manuals class, and the content definition format is described in the documentation directory. The TIS-3D mod is cited as an example of a mod that uses an in-game manual. Only the client needs the library to show manuals, while the server may run without it.

The project is released under the MIT License and is open source, with public source code and an issue tracker. Files are published for NeoForge 1.21.1 only, with 1.3.1 as the latest file, first published and last updated on 2026-05-30.

Key features

  1. In-game manuals

    Creates a book-style manual that opens in the game and displays content written in Markdown.

  2. Manuals registry

    New manuals are registered through a registry, and the manual is then tied to a registered item.

  3. Linked documents

    Content documents can link to other content documents, so a manual can be split into related pages.

  4. Embedded images

    Images from blocks and items can be placed in a document using Markdown-style image references.

Compatibility

Latest build for each game version and loader.

1.21.11.3.1
ReleaseBetaAlphaNot available

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

Use cases

Mod documentation

A mod author can ship a guide to its items and blocks inside the game instead of in an external wiki.

Who it’s for: Mod developers who want an in-game guide for their content. Players of mods that use it will see the manuals, and server owners need not install it.

Questions

Does Markdown Manual: Renewed need to be on the server?

No. It works on the client alone, and the server may run without it, but players need it installed to read the manuals.

Which loader and version does Markdown Manual: Renewed support?

The mod is published for NeoForge 1.21.1 only. The latest file is 1.3.1 for 1.21.1.

How is a new manual defined in Markdown Manual: Renewed?

Content is defined as Markdown documents, and setup code is described in the Manuals class and the doc directory of the project.

In the catalog

Markdown Manual: Renewed is one of 3,514 Library mods on ModsFinder, and one of 1,449 Library mods for NeoForge. 32,366 mods support Minecraft 1.21.1.

More from ewoudje

All projects

Similar mods

What the author says

MarkdownManual: Renewed is a library mod enabling in-game manuals with content defined in Markdown documents ported to later version(s). 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…
ewoudje, on the Modrinth page

Official listing

Owner
ewoudje
Published
2026-05-30
Updated on Modrinth
2026-05-30
Facts verified
2026-10-15

Tags