Skip to content

README.md

Latest commit

 

History

History
37 lines (22 loc) · 1.12 KB

README.md

File metadata and controls

37 lines (22 loc) · 1.12 KB
Raw

postguard-docs

For full documentation, visit docs.postguard.eu.

The central documentation site for the PostGuard project. Built with VitePress and hosted at docs.postguard.eu.

This site contains guides, SDK reference documentation, integration instructions, and per-repository documentation for all repos in the encryption4all organization.

Development

Prerequisites

  • Node.js 22+

Running Locally

npm install
npm run docs:dev

The dev server starts with hot reload at http://localhost:5173.

Building

npm run docs:build
npm run docs:preview   # preview the built site

Releasing

Pushing to main triggers .github/workflows/ci.yml, which builds and pushes the Docker image to ghcr.io/encryption4all/postguard-docs:edge. There is no automatic deploy step. The host running production at docs.postguard.eu (an NGINX container serving the built docs/.vitepress/dist) has to pull the new edge tag and restart the container to pick up changes.

License

MIT