Apache Asyncband (Incubating) Website

Clone this repo:

Branches

  1. 6f26171 ci: protect site branch with a ruleset (#5) by tison · 21 hours ago main
  2. 7dc68ec feat: add ASF logo favicon (#4) by tison · 22 hours ago
  3. 816cce2 ci: add ASF deployment workflow and simplify site tooling (#2) by tison · 23 hours ago
  4. 240f97e feat: build initial SvelteKit website (#1) by tison · 26 hours ago
  5. 5174a73 chore: Enable issues feature in .asf.yaml by tison · 2 days ago

Apache Asyncband (Incubating) Website

This repository contains the source for the Apache Asyncband (Incubating) website. Read the project DISCLAIMER and learn what incubation means.

Developing

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.

Writing documentation

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.

Validating

Run the type, formatting, lint, and production-build checks:

pnpm validate

Building and previewing

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/.

License

Licensed under the Apache License, Version 2.0.