@colletdev/docs
v0.2.40
Published
Collet component library documentation — API reference, framework guides, and AI agent setup
Maintainers
Readme
@colletdev/docs
API reference and framework integration guides for the Collet component library -- 48 accessible web components built in Rust/WASM.
Install
npm install @colletdev/docsContents
| File | Export | Description |
|------|--------|-------------|
| index.md | @colletdev/docs | Library overview and architecture |
| components.md | @colletdev/docs/components | All 48 components: props, events, slots, ARIA |
| core.md | @colletdev/docs/core | init() options, theming, CSS architecture, SSR |
| react.md | @colletdev/docs/react | React 18+ wrappers, hooks, ref types, events |
| vue.md | @colletdev/docs/vue | Vue 3.3+ wrappers, Volar setup, emits |
| svelte.md | @colletdev/docs/svelte | Svelte 5 runes wrappers, callback props |
| angular.md | @colletdev/docs/angular | Angular 16+ standalone components, forms |
Usage
Import the markdown content directly:
import components from '@colletdev/docs/components';
import react from '@colletdev/docs/react';This package ships .md files and a CLI. Use it to build documentation sites, power in-app help, or set up AI agent context.
AI Agent Setup
Set up Collet knowledge for your AI coding assistant:
npx @colletdev/docs init # auto-detect (Claude Code by default)
npx @colletdev/docs init --claude # Claude Code (.claude/skills/collet/)
npx @colletdev/docs init --codex # OpenAI Codex (AGENTS.md)
npx @colletdev/docs init --cursor # Cursor AI (.cursor/rules/collet.md)
npx @colletdev/docs init --all # All formatsThe CLI auto-detects your framework from package.json and generates context-aware agent configuration with the full 48-component API reference.
Related Packages
| Package | Description |
|---------|-------------|
| @colletdev/core | Custom Elements + WASM runtime |
| @colletdev/react | React 18+ wrappers |
| @colletdev/vue | Vue 3.3+ wrappers |
| @colletdev/svelte | Svelte 5 wrappers |
| @colletdev/angular | Angular 16+ wrappers |
License
MIT -- github.com/Danrozen87/collet
