helpers4 — Website

Unified documentation portal for all helpers4 projects.

---

Overview

This repository powers helpers4.dev — a unified Astro + Starlight documentation site for every helpers4 project.

Architecture

helpers4.dev/
├── /typescript/              # TypeScript helpers docs
├── /devcontainer/            # DevContainer features docs
└── /action/                  # GitHub Actions docs

All content lives under src/content/docs/ and is served by a single Astro + Starlight instance.

Prerequisites

• Node.js >= 24.0.0
• pnpm >= 9.0.0

Getting Started

git clone https://github.com/helpers4/website.git
cd website
pnpm install

Development

pnpm dev          # Start dev server (localhost:4321)

Build

pnpm build        # Build static site into dist/
pnpm preview      # Preview the built site locally

Documentation Generation

Docs are auto-generated from the source repositories (must be cloned as siblings):

pnpm generate-docs:typescript      # TypeScript API docs → src/content/docs/typescript/
pnpm generate-docs:devcontainer    # DevContainer feature docs → src/content/docs/devcontainer/
pnpm generate-docs:action          # GitHub Action docs → src/content/docs/action/
pnpm sync-from-repos               # All generators at once

Source repos are expected at ../typescript, ../devcontainer, ../action relative to this folder.

Deployment

The site is deployed to Cloudflare Pages on every push to main.

Setting	Value
Build command	pnpm install && pnpm build
Publish directory	dist
Domain	helpers4.dev

Contributing

See the Contributing Guide.

License

This project is licensed under the GNU Lesser General Public License v3.0 or later.

Contributors

Bérenger