Skip to content

Latest commit

 

History

History

README.md

OpenScreen docs site

Docusaurus 3 site. Lives in website/ inside the monorepo. Deployed to GitHub Pages via .github/workflows/docs.yml.

Develop

cd website
npm install
npm run dev      # http://localhost:3000/openscreen/

Build

npm run build    # outputs to website/build/
npm run serve    # serves the built site locally

Type-check

npm run typecheck

Notes

  • Site URL: https://getopenscreen.github.io/openscreen/
  • The base URL is /openscreen/ because the org-level Pages site hosts multiple projects.
  • Docs migration from docs/ (root) → website/docs/ happens in a follow-up PR. For now only the intro page is published.