The Modded Minecraft Wiki is built to suit the very needs of Minecraft modders and players alike. It provides intuitive navigation, a clean user interface, mod browser and features for authors to make writing documentation a piece of cake.
These include versioning, localization, custom components (recipes, assets, etc.), gradle integration, project management and more.
- 🌐 Localization: Translate your docs into world languages
- 🚹 Accessible: Intuitive and responsive user interface
- 🤝 Open: Let your users contribute without any programming knowledge necessary
- 💸 Free: Hosting docs on our website is completely free of charge!
📘 Read the complete author guide here.
An example documentation setup can be found in the example directory of this repository.
Ensure you have the latest version of Node.js and pnpm installed.
- Install dependecies by running
pnpm install - Rename
.env.local.exampleto.env.local - Run
pnpm run devto start the app
To open the example project, enable local preview mode by setting ENABLE_LOCAL_PREVIEW=true or manually navigate
to /project/examplemod.
You can list desired local documentation sources in the LOCAL_DOCS_ROOTS env variable as demonstrated in the example.
- Minecraft typeface by Mojang
Massive thanks to everyone who has contributed to translation efforts!
Special graditude goes to our most significant contributors:
- @moritz-htk for German translations
- @notlin4 for Traditional Chinese translations
- @kikipunk for French translations
