Pocket ID is the most user-friendly OpenID Connect Certified™ and OAuth 2.0 provider that lets users sign in to your applications with passkeys.
This repository holds pocket-id.org: the landing page and the documentation. It's built with Astro and Starlight.
- Install the dependencies:
pnpm install
- Start the development server:
pnpm dev
The site runs at http://localhost:4321 and reloads when you save a file.
Formatting, linting and type checks run with Vite+: pnpm check runs all of them, and a commit hook fixes the staged files. With the vp CLI installed, vp install, vp run dev and vp check work as well.
| Path | Contents |
|---|---|
src/content/docs/docs/ |
The documentation pages, one Markdown file per page |
src/pages/index.astro |
The landing page |
src/components/ |
Diagrams, screenshots, the API reference and the landing page's components |
astro.config.mjs |
Site settings and the sidebar |
The API reference reads the Swagger spec in src/generated, which is generated from the backend's code with swag and committed, so the site builds without Go.
The Update API spec workflow regenerates it from the main branch of pocket-id/pocket-id every hour and commits it when it changed.
To regenerate it yourself, run pnpm openapi with Go installed and a checkout of pocket-id next to this repository, or wherever POCKET_ID_DIR points.
See the documentation guide for how to write pages.
The site is hosted on Vercel, which builds it from the repository with pnpm build, and redirects for moved pages go in redirects in astro.config.mjs.
- Pushes to
maindeploy to production - Pushes to
previewdeploy the docs of the unreleased version, at the domain assigned to the branch in Vercel - Pull requests get a preview deployment, linked in a comment by Vercel
Every page is prerendered, except for two server islands that Vercel renders on request and caches for an hour: the numbers on the landing page and the sponsor list.