Skip to content

Repository files navigation

Reedwork Documentation

This repository contains the source for the official Reedwork documentation website.

The documentation is built with Astro and Starlight and deployed to GitHub Pages.

🌐 Website: https://reedworkmc.github.io/

📦 Main project: https://github.com/ReedworkMC/Reedwork

📚 Examples: https://github.com/ReedworkMC/ReedworkExamples

Development

Install dependencies:

npm install

Start the local development server:

npm run dev

Build the documentation:

npm run build

The generated site is written to dist/.

Deployment

Deployments are handled automatically through GitHub Actions when changes are pushed to the master branch.

The site is hosted using GitHub Pages.

License

The website source code is licensed under the MIT License.

Third-party dependencies, assets, and trademarks remain subject to their respective licenses and rights.