Oraxen Documentation

The official documentation website for creating custom Minecraft content with Oraxen.

Overview

Oraxen Documentation is the source for the official Oraxen documentation website. It explains how to configure and use Oraxen, create custom items and resources, integrate supported plugins, and extend Oraxen through its API.

The website is built with Docusaurus. Documentation pages are written in MDX and organized through a manually maintained sidebar.

Features

• Documents Oraxen installation, configuration, commands, recipes, settings, resource-pack hosting, and usage.
• Covers custom items, glyphs, HUDs, text effects, sounds, paintings, mechanics, and item data.
• Includes tutorials and compatibility guides for supported plugins and world generators.
• Provides developer guides for compiling Oraxen, adding mechanics and integrations, and using the API.
• Supports reusable React components inside MDX documentation pages.
• Includes syntax highlighting for Java, Groovy, YAML, PowerShell, and batch files.
• Builds a static website suitable for production hosting.

Requirements

• Node.js 20 or newer.
• npm.

Installation

Install the project dependencies.

npm install

Development

Start the local development server with live reload.

npm run start

Create a production build.

npm run build

The generated static site is written to build/. Preview it locally after building.

npm run serve

Project entry points.

• Documentation pages - docs/
• Sidebar configuration - sidebars.js
• Site configuration - docusaurus.config.js
• Custom components - src/components/
• Theme styles - src/css/custom.css