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!
An example documentation setup can be found in the example directory of this repository.
- Rename
.env.local.exampleto.env.local - Create a new GitHub App. Fill in the following information:
APP_AUTH_GITHUB_ID- App IDAPP_AUTH_GITHUB_PRIVATE_KEY- a generated Private KeyAUTH_GITHUB_ID- Client IDAUTH_GITHUB_SECRET- Client Secret
- Configure Prisma's database connection.
See
prisma/schema.prismafor the required environment variable names. - Run
npm run devto start the app
You can list desired local documentation sources in the LOCAL_DOCS_ROOTS env variable as demonstrated in the example.
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
