Description
Gallery
Changelog
Versions
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 ).
Here are some example screenshots, demonstrating how flexible the styling of the default manual UI is. Same content three times with different skins:
All Versions
+ Add Version| Name | Game version | Platforms | Published | Downloads | Actions |
|---|---|---|---|---|---|
| 1mo ago | 1 | ||||
| 1mo ago | 1 | ||||
| 2mo ago | 1 | ||||
| 2mo ago | 1 | ||||
| 2mo ago | 1 | ||||
| 2mo ago | 1 | ||||
| 2mo ago | 1 | ||||
| 2mo ago | 1 | ||||
| 3mo ago | 1 | ||||
| 3mo ago | 1 | ||||
| 3mo ago | 1 | ||||
| 3mo ago | 1 | ||||
| last yr. | 1 | ||||
| last yr. | 1 | ||||
| last yr. | 1 | ||||
| last yr. | 1 | ||||
| last yr. | 1 | ||||
| last yr. | 1 | ||||
| last yr. | 1 | ||||
| last yr. | 1 | ||||
| last yr. | 1 | ||||
| last yr. | 1 | ||||
| last yr. | 1 | ||||
| last yr. | 1 | ||||
| last yr. | 1 | ||||
| last yr. | 1 | ||||
| last yr. | 1 | ||||
| last yr. | 1 | ||||
| last yr. | 1 | ||||
| last yr. | 1 | ||||
| last yr. | 1 | ||||
| last yr. | 1 | ||||
| last yr. | 1 | ||||
| last yr. | 1 |
[MC1.21.1-neoforge-1.2.8] MarkdownManual-MC1.21.1-1.2.8
by Sangar on Sep 24, 2026
Download
Fix code blocks being refined further.
[MC1.21.1-fabric-1.2.8] MarkdownManual-MC1.21.1-1.2.8
by Sangar on Sep 24, 2026
Download
Fix code blocks being refined further.
[MC1.21.11-neoforge-1.2.7] MarkdownManual-MC1.21.11-1.2.7
by Sangar on Aug 24, 2026
Download
Just internal cleanup, mostly.
[MC1.21.11-fabric-1.2.7] MarkdownManual-MC1.21.11-1.2.7
by Sangar on Aug 24, 2026
Download
Just internal cleanup, mostly.
[MC1.21.1-neoforge-1.2.7] MarkdownManual-MC1.21.1-1.2.7
by Sangar on Aug 23, 2026
Download
Just internal cleanup, mostly.
[MC1.21.1-fabric-1.2.7] MarkdownManual-MC1.21.1-1.2.7
by Sangar on Aug 23, 2026
Download
Just internal cleanup, mostly.
[MC1.21.1-fabric-1.2.7] MarkdownManual-MC1.21.1-1.2.7
by Sangar on Aug 23, 2026
Download
Just internal cleanup, mostly.
[MC1.21.1-neoforge-1.2.7] MarkdownManual-MC1.21.1-1.2.7
by Sangar on Aug 23, 2026
Download
Just internal cleanup, mostly.
[MC1.21.11-fabric-1.2.6] MarkdownManual-MC1.21.11-1.2.6
by Sangar on Aug 09, 2026
Download
Port to 1.21.11.
[MC1.21.11-neoforge-1.2.6] MarkdownManual-MC1.21.11-1.2.6
by Sangar on Aug 09, 2026
Download
Port to 1.21.11.
[MC1.21.1-fabric-1.2.6] MarkdownManual-MC1.21.1-1.2.6
by Sangar on Aug 08, 2026
Download
Port to 1.21.1.
[MC1.21.1-neoforge-1.2.6] MarkdownManual-MC1.21.1-1.2.6
by Sangar on Aug 08, 2026
Download
Port to 1.21.1.
[MC1.20.4-fabric-1.2.6] MarkdownManual-MC1.20.4-1.2.6
by Sangar on Apr 15, 2024
Download
- Update to MC 1.20.4.
- Add support for NeoForge Loader.
Special thanks and apologies to @thiakil who made a PR for this, but which I completely missed 😢
[MC1.20.4-forge-1.2.6] MarkdownManual-MC1.20.4-1.2.6
by Sangar on Apr 15, 2024
Download
- Update to MC 1.20.4.
- Add support for NeoForge Loader.
Special thanks and apologies to @thiakil who made a PR for this, but which I completely missed 😢
[MC1.20.4-neoforge-1.2.6] MarkdownManual-MC1.20.4-1.2.6
by Sangar on Apr 15, 2024
Download
- Update to MC 1.20.4.
- Add support for NeoForge Loader.
Special thanks and apologies to @thiakil who made a PR for this, but which I completely missed 😢
[MC1.20.2-fabric-1.2.6] MarkdownManual-MC1.20.2-1.2.6
by Sangar on Nov 16, 2023
Download
- Port to MC 1.20.2.
- Use tab provider sort order for tabs.
[MC1.20.2-forge-1.2.6] MarkdownManual-MC1.20.2-1.2.6
by Sangar on Nov 16, 2023
Download
- Port to MC 1.20.2.
- Use tab provider sort order for tabs.
[MC1.20.1-fabric-1.2.5] MarkdownManual-MC1.20.1-1.2.5
by Sangar on Nov 16, 2023
Download
- Fixed using Fabric Loader internals, could cause crash when using newer versions of Fabric Loader.
[MC1.20.1-forge-1.2.5] MarkdownManual-MC1.20.1-1.2.5
by Sangar on Nov 16, 2023
Download
- Fixed using Fabric Loader internals, could cause crash when using newer versions of Fabric Loader.
[MC1.20.1-fabric-1.2.4] MarkdownManual-MC1.20.1-1.2.4
by Sangar on Aug 23, 2023
Download
- Fix potential division by zero.
[MC1.20.1-forge-1.2.4] MarkdownManual-MC1.20.1-1.2.4
by Sangar on Aug 23, 2023
Download
- Fix potential division by zero.
[MC1.20.1-fabric-1.2.3] MarkdownManual MC1.20.1-1.2.3
by Sangar on Aug 20, 2023
Download
Ported to MC 1.20.1.
[MC1.20.1-forge-1.2.3] MarkdownManual MC1.20.1-1.2.3
by Sangar on Aug 20, 2023
Download
Ported to MC 1.20.1.
[MC1.19.3-fabric-1.2.3] markdown_manual-1.2.3+ff62d5c
by Sangar on Jan 06, 2023
Download
- Add Fabric extension point to allow mods to safely register objects with our registries.
[MC1.19.3-forge-1.2.3] markdown_manual-1.2.3+ff62d5c
by Sangar on Jan 06, 2023
Download
- Add Fabric extension point to allow mods to safely register objects with our registries.
[MC1.19.2-fabric-1.2.3] markdown_manual-1.2.3+87774e1
by Sangar on Jan 06, 2023
Download
- Add Fabric extension point to allow mods to safely register objects with our registries.
[MC1.19.2-forge-1.2.3] markdown_manual-1.2.3+87774e1
by Sangar on Jan 06, 2023
Download
- Add Fabric extension point to allow mods to safely register objects with our registries.
[MC1.19.3-fabric-1.2.2] markdown_manual-1.2.2+f8350a3
by Sangar on Jan 06, 2023
Download
- Update to MC 1.19.3.
[MC1.19.3-forge-1.2.2] markdown_manual-1.2.2+f8350a3
by Sangar on Jan 06, 2023
Download
- Update to MC 1.19.3.
[MC1.19.2-fabric-1.2.2] markdown_manual-1.2.2+c5f3e6f
by Sangar on Jan 01, 2023
Download
- Switch to Artifactory, update to 1.19.2.
