RUI.next

Getting Started

Getting Started

Overview

Thanks to vpressify that could support React docs+demos well to run with vite.

Compare to other tools:

  • dumi
    • it is coupled with webpack instead.
  • vuepress@next with vite bundler
    • it seems not good enough to support React docs+demos.
  • vite-plugin-react-pages
    • for early version, it seems not able to show both demos and source codes in the CodeBlock.
  • vitepress-rc / pressify
    • it lacks of regular maintenance.

Preview

Try QR code playground to scan to access the examples on mobile/tablet device.

Project setup

Install dependencies

$ pnpm i
$ pnpm i

Start the dev server for docs-dev

$ pnpm start
$ pnpm start

Build UI library

$ pnpm run build-lib
$ pnpm run build-lib

Build documentation (docs+demos)

$ pnpm run build-docs
$ pnpm run build-docs

License

MIT License