Simple mod integration
If you don't want to create full documentation for your mod, and you need just one topic to document your mod, you may do that using this one-file mod integration. All you need is to create a single Markdown file at a specific location within your mod's resources.
The Markdown file
To add one-file mod integration, create a Markdown file located in your mod's resources at
src/main/resources/Common/Docs/{YourModGroup}_{YourModName}.md
After creating the file, specify its front-matter and the Markdown content after it.
---
name: My mod documentation
description: How to use my mod
author: Myself
---
# My mod
My mod adds ... and ...
Save the file, recompile the mod, restart your development server and you should be able to see documentation titled Various mods under which your topic named My mod documentation will be shown. This documentation is shown after all other mod documentations.
For further reading, please see the following topics.
12 April 2026