The website is built with PostDoc (a new static site generator built with Vite and EJS, currently in preview). It supports Markdown, EJS, and front matter.
It comes with a dev server with hot reload.
npm install
npm run clone:docs && npm run clone:nightwatch
npm start
To view the available options, run:
npx postdoc --help
npm start -- --open [chrome|firefox|edge|safari]
To build the website, run:
npm run build
The generated files will be in the out
folder. You can serve them with any static server.
Quickly serve the generated files with:
npx serve out
In order to deploy to the production server, you need to create a PR for the release/v1.0
branch.
The PR requires at least 2 approvals from the maintainers. Once the PR is merged, the website will be automatically deployed to the production server.
MIT