Mods
Resource Packs
Data Packs
Modpacks
Shaders
Plugins
Mods Resource Packs Data Packs Plugins Shaders Modpacks
Get Modrinth App Upgrade to Modrinth+
Sign in
ModsPluginsData PacksShadersResource PacksModpacks
Sign in
Settings
Markdown Manual

Markdown Manual

Library mod for creating in-game manuals.

27.6k
11
Library

Compatibility

Minecraft: Java Edition

1.20.4
1.20.1–1.20.2
1.19.2–1.19.3
1.19
1.18.2

Platforms

Fabric
Forge
NeoForge

Supported environments

Client and server

90% of ad revenue goes to creators

Support creators and Modrinth ad-free with Modrinth+

Links

Report issues View source
Donate on Patreon

Creators

Sangar
Sangar Owner

Details

Licensed MIT
Published 3 years ago
Updated last year
DescriptionGalleryChangelogVersions

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 existing UI. This mod adds no player-facing content on its own.

For an example of how to use this library, see TIS-3D, which uses this for its in-game manual. For the required setup in code, please see the Manuals class. For content definition of the manual, please see the doc directory. But the short of it is: register a new manual with the manuals registry, register content for the new manual, register an item to make the manual available to players. Content documents are Markdown documents that may have links to other content documents. Images and blocks/items can be embedded using Markdown style image references (for example ![Tooltip](block:minecraft:furnace)).

Here are some example screenshots, demonstrating how flexible the styling of the default manual UI is. Same content three times with different skins:

Default UI.

Custom UI.

Custom dark UI.

Modrinth is open source.

main@4b75cb8

© Rinth, Inc.

Company

TermsPrivacyRulesCareers

Resources

SupportBlogDocsStatus

Interact

Discord X (Twitter) Mastodon Crowdin
Get Modrinth App Settings
NOT AN OFFICIAL MINECRAFT SERVICE. NOT APPROVED BY OR ASSOCIATED WITH MOJANG OR MICROSOFT.