Documentation site for Music Assistant built with Astro Starlight.
๐ Live Site: https://music-assistant.io
๐ Beta Site: https://beta.music-assistant.io
Opening a pull request? See CONTRIBUTING.md first. Documentation pull
requests go to the beta branch, and adding a music source or player provider takes a few steps
beyond writing the page.
# Install dependencies
npm install
# Start development server
npm run dev
# Build for production
npm run build
# Preview production build
npm run preview- Framework: Astro with Starlight
- Node Version: 22+
- Dev Server: http://localhost:4321
/
โโโ src/
โ โโโ content/docs/ # Markdown documentation files
โ โโโ styles/ # Custom CSS (branding)
โ โโโ components/ # Custom Astro components
โ โโโ assets/ # Logo files
โโโ public/
โ โโโ assets/ # Static images
โ โโโ videos/ # Video files
โ โโโ callback/ # OAuth callback endpoint
โ โโโ cast-receiver/ # Google Cast receiver
โโโ astro.config.mjs # Astro configuration
โโโ dist/ # Build output
- Edit markdown files in
src/content/docs/ - Add YAML frontmatter with a
titlefield - Use Starlight syntax for special elements
- Reference images with absolute paths:
/assets/image.png - Internal links use extensionless format:
/installation(not/installation.md)
Beta can be worked on from the beta branch of the repo and preview on beta.music-assistant.io.
