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 Hex Grid Package: https://www.npmjs.com/package/@vanduo-oss/hex-grid Charts Package: https://www.npmjs.com/package/@vanduo-oss/charts Flowchart Package: https://www.npmjs.com/package/@vanduo-oss/flowchart

Current Snapshot

  • Docs content now includes the v1.4.2 changelog, scoped runtime guidance, lifecycle manager docs, security practices, and canonical token guidance.
  • Vanduo Charts is documented as the standalone @vanduo-oss/charts package with SVG chart demos and Vanduo lifecycle auto-init examples.
  • Vanduo Flowchart is documented as the standalone @vanduo-oss/flowchart package with a live editor demo, primitive palette, and JSON import/export workflow.
  • Production docs load the pinned framework CDN bundle from @v1.4.2, while local preview resolves framework assets from ./dist and refreshes them from the sibling framework repo when available.
  • Theme docs now treat --vd-* semantic and component tokens as the strict Vanduo API.
  • Framework integration docs now recommend scoped Vanduo.init(root), Vanduo.destroy(root), and Vanduo.reinit(name, root) for SPAs and dynamic DOM.

Labs

The Labs section now focuses on experimental search and AI components. Hex Grid has graduated into the standalone @vanduo-oss/hex-grid package and repository.

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