Skip to content

Document base UI components with live previews - #650

Draft
ruibaby wants to merge 1 commit into
mainfrom
docs/base-components-api-reference
Draft

ruibaby wants to merge 1 commit into
mainfrom
docs/base-components-api-reference

Conversation

@ruibaby

@ruibaby ruibaby commented Nov 19, 2026

Copy link
Copy Markdown
Member

Summary

This adds a dedicated API reference for @halo-dev/components 2.27 with live previews, and renames the existing components section to business components.

  • New base-components section documenting all 21 component groups plus the icon set.
  • Each page includes import usage, live examples, props, emits, and slots.
  • components is now labeled "业务组件" and links to the base component overview.
  • Previews use @rspress/plugin-preview with a Vue customEntry backed by @rsbuild/plugin-vue.

Preview setup

vue code blocks marked with preview are compiled by a separate Rsbuild instance and rendered in a follow-along iframe. The preview entry imports @halo-dev/components/dist/style.css, and demo assets are emitted to build/~demo/. Dependencies are pinned to the Halo 2.27 component library (@halo-dev/components@2.27.0, vue@^3.5.45, vue-router@5.1.0, @vueuse/core@^14.4.0).

Validation

  • pnpm check:ci
  • pnpm build
  • Checked 22 component pages and 82 preview demos against the production build; all preview roots render.

@cloudflare-workers-and-pages

Copy link
Copy Markdown

Deploying with  Cloudflare Workers  Cloudflare Workers

The latest updates on your project. Learn more about integrating Git with Workers.

Status Name Latest Commit Preview URL Updated (UTC)
✅ Deployment successful!
View logs
docs c31374b Commit Preview URL

Branch Preview URL
Nov 19 2026, 03:11 PM

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant