https://github.com/neoforged/documentation

The repository containing Neo's documentation
https://github.com/neoforged/documentation

documentation docusarus hacktoberfest neoforge

Last synced: 5 days ago
JSON representation

The repository containing Neo's documentation

• Host: GitHub
• URL: https://github.com/neoforged/documentation
• Owner: neoforged
• License: mit
• Created: 2023-07-09T19:35:29.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2025-01-03T10:24:36.000Z (8 days ago)
• Last Synced: 2025-01-03T11:30:01.341Z (8 days ago)
• Topics: documentation, docusarus, hacktoberfest, neoforge
• Language: MDX
• Homepage: https://docs.neoforged.net
• Size: 2.36 MB
• Stars: 29
• Watchers: 9
• Forks: 57
• Open Issues: 33
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 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](https://docusaurus.io)

## Contributing

You can read the [contribution guidelines on the docs](https://docs.neoforged.net/contributing/).

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:

```bash

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.

```bash

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:

```bash

npm run build

```

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