Generating documentation

With Packrinth, it is possible to automatically generate documentation based on the branch files. To do this, run this:

$ packrinth doc

The documentation will be printed, and you can use it for your modpack frontpage. It includes the name, author, summary and all the branch files.

This is a modpack.json configuration example for Client+, a modpack that uses Packrinth:

{
        "pack_format": 1,
        "name": "Client+",
        "summary": "Modpack focused on improving vanilla Minecraft on the client-side.",
        "author": "Thijzert (https://github.com/Thijzert123)",
        "require_all": true,
        "auto_dependencies": true,
        "branches": [
                "1.21.8",
                "1.21.7",
                "1.21.6",
                "1.21.5",
                "1.21.4",
                "1.21.3",
                "1.21.1",
                "1.20.4",
                "1.20.1"
        ],
        "projects": {}
}

modpack.json (all projects were omitted)

Below is the generated config output from packrinth doc (to keep the page concise, some projects were omitted).

If you only want the project table to be printed, you can use the --table-only flag.

---

Client+ by Thijzert (https://github.com/Thijzert123)

Modpack focused on improving vanilla Minecraft on the client-side.

What is included?

Name	1.21.8	1.21.7	1.21.6	1.21.5	1.21.4	1.21.3	1.21.1	1.20.4	1.20.1
Searchables	✅	✅	✅	✅	✅	✅	✅	✅	✅
Show Me Your Skin!	✅	✅	✅	❌	❌	❌	✅	✅	✅
Simple Grass Flowers	✅	✅	✅	✅	✅	✅	❌	❌	❌
Spryzeen’s Healthbars	❌	❌	✅	❌	❌	❌	❌	❌	❌
Spryzeen’s Knight Armor	❌	❌	✅	✅	✅	✅	❌	❌	❌
Status Effect Bars	✅	✅	✅	✅	✅	✅	✅	✅	✅
Vervada’s enhanced plants	❌	❌	✅	✅	✅	✅	❌	❌	❌
View Bobbing Options	✅	✅	✅	✅	✅	✅	✅	✅	✅