ci: protect site branch with a ruleset (#5)
This repository contains the source for the Apache Asyncband (Incubating) website. Read the project DISCLAIMER and learn what incubation means.
Install dependencies and start the SvelteKit development server:
pnpm install
pnpm dev
The local site is available at http://localhost:5173/ by default.
Pagefind search is generated from the static HTML during pnpm build, so use the production preview below when testing search.
Documentation pages live under src/routes/docs/ as MDsveX .svx files. Each page starts with frontmatter for its navigation label and metadata; the rest of the file is Markdown.
Second-level headings generate the on-page table of contents automatically. Fenced bash and rust code blocks are highlighted during the build. MDsveX also supports Svelte components when a document needs behavior beyond Markdown.
Run the type, formatting, lint, and production-build checks:
pnpm validate
Generate the static site and preview the result locally:
pnpm build
pnpm preview
The generated site is written to build/. Pushing to main builds and publishes the site through the asf-site branch.
To publish a staging preview, push the site source to a branch named preview/<name>. The same deployment workflow publishes the build through site/<name>-staging, which ASF serves at https://asyncband-<name>.staged.apache.org/.
Licensed under the Apache License, Version 2.0.