Skip to content

vanduo-oss/docs

Repository files navigation

Vanduo Docs

Documentation and website for Vanduo, served at https://vanduo.dev.

Framework repo: https://github.com/vanduo-oss/framework NPM Package: https://www.npmjs.com/package/@vanduo-oss/framework

Current Snapshot

  • Docs are aligned with the v1.3.4 release surface.
  • Production docs load the pinned framework CDN bundle from @v1.3.4, while local preview resolves framework assets from ./dist and refreshes them from the sibling framework repo when available.
  • Theme tooling is documented as two separate components: Theme Switcher for lightweight system/light/dark toggles and Theme Customizer for full palette, neutral, radius, and font control.
  • v1.3.4 introduces the Glass Effects documentation page (Effects category) and a site-wide glass visual upgrade across the docs UI.

Labs

The Labs section showcases experimental components such as the vd-hex hex grid demo. See the Labs page for details.

Installation

We strongly recommend using pnpm. The Vanduo ecosystem uses strict .npmrc security policies for dependency isolation and lockfile enforcement.

pnpm add @vanduo-oss/framework

Local preview

Use the local preview script so the docs shell resolves framework assets from ./dist instead of the published CDN bundle.

pnpm run preview:local

When the sibling ../vanduo-framework repo is present, the preview script refreshes vanduo-docs/dist from ../vanduo-framework/dist before serving the site. If the framework repo is unavailable, the script falls back to the vendored dist/ copy already tracked in this repo.

To refresh the local framework assets without starting the server:

pnpm run sync:framework

For a direct file:// preview, run the sync step first so the local dist/ assets match the latest framework build.

Validation

pnpm test