Skip to content

arraypress/waveform-docs

Repository files navigation

WaveformPlayer Docs

The documentation site for the @arraypress waveform family — a small, zero-dependency set of vanilla-JS audio components: a canvas waveform player, a persistent bottom bar, playlists, listen analytics, and build-time peak tooling.

Built with Astro + Starlight, themed to match the marketing site (waveformplayer.com). Live at docs.waveformplayer.com.

Develop

npm install
npm run dev      # local dev server
npm run build    # production build to ./dist
npm run preview  # preview the build

Notable bits

  • Live demos. The docs embed real, playable players (PlayerDemo, BarDemo, PlaylistDemo, TrackerDemo) that load each package's runtime from CDN — so what you read is what you get.
  • Changelog. npm run sync:changelogs regenerates the per-library changelog pages under src/content/docs/changelog/ from each package's own CHANGELOG.md. The generated .md files are committed (the site deploys standalone, with no access to the sibling packages), so re-run it after a release.
  • Agent-friendly. Every page has a "Copy page / View as Markdown / Open in Claude·ChatGPT" header action, plus per-page .md endpoints.

License

MIT © ArrayPress