Observables.Docs

Static documentation for Skymly/Observables, built with VitePress (local search, English + 简体中文).

Live site

https://skymly.github.io/Observables.Docs/

Deployed from main via the GitHub Pages workflow (build_type: workflow).

Prerequisites

• Node.js 22 (see .nvmrc)

Local development

npm install
npm run docs:dev

Default dev URL: http://localhost:5173/Observables.Docs/

Build and preview

npm run docs:build
npm run docs:preview

Production output: .vitepress/dist

Repository layout

Path	Purpose
docs/	English Markdown
docs/zh/	简体中文 Markdown
.vitepress/config.mts	Site config, base, i18n, sidebar
.github/workflows/github-pages.yml	CI build and GitHub Pages deploy

Related

Link	Description
Observables	Source generators and runtime
Observables.Samples	Runnable sample apps

License

MIT — see LICENSE.