legobmw99 / neoforge-doc

The repository containing Neo's documentation

NeoForged Documentation

This repository is used to store documentation on NeoForge, the Minecraft modding API. It also contains documentation on NeoGradle, a Gradle plugin for developing NeoForge and mods using NeoForge.

The documentation is built using Docusaurus 3

Contributing

You can read the contribution guidelines on the docs.

If you wish to contribute to the documentation, fork and clone this repository.

The documentation uses Node.js 18. This can either be installed manually or using a version manager that supports .node-version or .nvmrc. For most version managers, the install and/or use command can be used to setup the correct Node.js version.

For example:

nvm install # or 'nvs use'

You can run the following commands if you wish to preview the documentation website locally through the live development server. Most changes are reflected live without having to restart the server.

npm install
npm run start

Building

If you wish to build a static version of the documentation which can be deployed, you can run the following command:

npm run build

This command generates static content into the build directory and can be served using any static contents hosting service.