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

Current Snapshot

  • Docs content now includes the v1.3.9 changelog and Theme Customizer documentation updates.
  • Production docs load the pinned framework CDN bundle from @v1.3.9, 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, now with charcoal and ubuntu as the documented defaults.
  • Current docs updates cover the Charcoal/Ubuntu Theme Customizer defaults, the Hex Grid graduation into its standalone package, and the production CDN pin aligned to @v1.3.9.

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