Documentation site for Wickra — streaming-first technical indicators. Built with VitePress, deployed via Cloudflare Pages.
npm install
npm run dev # http://localhost:5173
npm run build # static output -> .vitepress/dist
npm run preview # serve the built siteRequires Node 22 (see .nvmrc).
- The indicator count and the released version — the headline count on the
landing page and in
overview.md, the version table, the crate version inQuickstart-Rust.mdand the Maven snippet inQuickstart-Java.md— are pulled hourly from wickra bysync-from-wickra.yml(the count is derived from the core's re-export block, the version from its latest release). - The page-derived counts — per-family indicator counts, the sidebar groups
and "N deep-dive pages" — are owned by
scripts/sync-doc-counts.mjs; CI fails when they disagree with the pages, andnode scripts/sync-doc-counts.mjsrewrites them. - The status badges in the footer are snapshots refreshed hourly by
refresh-badges.yml; the SVGs inpublic/badges/are generated, not edited.
Everything else — every page, the hand-seeded sidebar groups (Getting started, Reference, Guides) — is edited here by hand.
Pages are plain Markdown at the repo root; the indicator deep-dives live under
Indicators/. The sidebar (.vitepress/sidebar.ts) is half generated: the
indicator-family groups are written by scripts/sync-doc-counts.mjs from the
pages that exist, the other groups (Getting started, Reference, Guides) are
edited by hand. CI compiles every Rust snippet and runs the Python and Node
ones against the published packages, so a page's code is code that works.
Static build via Cloudflare Pages (Git integration, no deploy secret).
| Setting | Value |
|---|---|
| Production branch | main |
| Build command | npm run build |
| Build output directory | .vitepress/dist |
| Node version | 22 (.nvmrc) |
Every push to main redeploys production; every PR gets a preview deployment.
Dual-licensed under MIT or Apache-2.0, at your option.