StollD/music-assistant-docs

Documentation repo for Music Assistant

โ˜… 0Forks 0GitHub โ†—Compare

README

music-assistant.io

Documentation site for Music Assistant built with Astro Starlight.

๐Ÿ”— Live Site: https://music-assistant.io

๐Ÿ”— Beta Site: https://beta.music-assistant.io

Contributing

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.

Quick Start

# Install dependencies
npm install

# Start development server
npm run dev

# Build for production
npm run build

# Preview production build
npm run preview

Development

Project Structure

/
โ”œโ”€โ”€ 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

Contributing

  1. Edit markdown files in src/content/docs/
  2. Add YAML frontmatter with a title field
  3. Use Starlight syntax for special elements
  4. Reference images with absolute paths: /assets/image.png
  5. Internal links use extensionless format: /installation (not /installation.md)

Beta Documentation

Beta can be worked on from the beta branch of the repo and preview on beta.music-assistant.io.


A project from the Open Home Foundation

Contributors

OzGavclaudejozefKruszynskidan-long-devmarcelveldttrudenboyMarvinSchenkelfmunkesmrdarrengriffinTommatheussenALERTuaowldownkherscryptkchrisutheremon1496macegranupammeHorgixoliofapophisnowJulienDeveauxxiasi0yoyixmsrwjackzweckjjonbngflorianhornerclang88alams154

Issues