Skip to content
FORBIDDEN OASIS · WATER

Run This Docs Site

Run This Docs Site

Section titled “Run This Docs Site”

This documentation package is a standalone Astro + Starlight static site prepared for Netlify.

Local development

Section titled “Local development”
Terminal window
npm install
npm run dev

Open the local URL shown by Astro.

Production build

Section titled “Production build”
Terminal window
npm run build
npm run preview

The deployable static output is created in dist/.

Deploy to Netlify

Section titled “Deploy to Netlify”

Push the project to GitHub, then import that repository into Netlify. The included netlify.toml supplies the complete build configuration:

[build]
  command = "npm run build"
  publish = "dist"

Netlify installs the dependencies, builds the documentation and publishes dist/. No Docker container or server is required.

Custom domain

Section titled “Custom domain”

After the first deploy, add this domain in Netlify:

https://docs.forbidden-oasis.xyz

Then create the DNS record specified by Netlify.