| .. | ||
| .vitepress | ||
| scripts | ||
| src | ||
| .gitignore | ||
| package.json | ||
| README.md | ||
| tsconfig.json | ||
About
@prozilla-os/docs is a VitePress website that contains the documentation for ProzillaOS.
Scripts
| Script | Description |
|---|---|
pnpm run start |
Start VitePress dev server at localhost:3000. Changes to module will dynamically be hot-reloaded, so normally there is no need for hard-refreshes. |
pnpm run build |
Compile project using VitePress and output to the dist directory. |
pnpm run preview |
Start web server with preview of build at localhost:8080. Can be useful for validating build before deploying. |
pnpm run stage |
Execute stage.ts, which copies the ./dist directory of this package into the /dist/docs directory at the root, within the build of the demo site. |
pnpm run generate |
Generate basic information files in JSON format to use as a base for writing the documentation and output to the data directory. |