Skip to content

Latest commit

 

History

History

README.md

QWindow Docs

GitHub Sponsors button PayPal donate button

Discord X

This package contains the Q-Press documentation site for QWindow. It owns the public documentation source, live demos, example-viewer content, generated API pages, and static-search output for windowing components and desktop-like interaction examples.

The docs app is a Quasar CLI Vite project inside the monorepo. Production docs should be built from the repository root so the UI package, app extension, generated API data, Q-Press route checks, and static output all describe the same release.

Development

From the repository root:

pnpm install
pnpm build:ui
pnpm --filter docs dev

Build

Build the full release set, including docs:

pnpm build

Build only the docs site after the UI package is already current:

pnpm build:docs

The docs package runs quasar build and qpress ssg; production output is emitted to packages/docs/dist/spa.

Checks

Useful repository-level checks for docs work:

pnpm api:check
pnpm check:qpress
pnpm --filter docs typecheck