How tusen-ai/naive-ui works
Project type and purpose
• This is a Vue 3 UI Component Library (“Naive UI”) written in TypeScript.
• It also includes a live documentation/demo site, playground tests, and a full build & release pipeline.
File structure
• Top‐level:
• build/ & scripts/ – custom Vite plugins, webpack loaders, bundling helpers, post/pre build scripts
• demo/ – documentation site built with Vite/Vue using markdown→Vue loaders under build/loaders
• playground/ – manual test apps (SSR, upload server, async validator demos)
• .github/workflows/ – CI definitions (Node.js tests, build checks, lint, publish)
• config files – babel.config.js, rollup.config.js, vite.config.js, tsconfig*, jest.config.js, eslint.config.mjs
• package.json, CHANGELOG, CONTRIBUTING, README – project metadata and instructions
• themes/ – example theme override packages
README for additional insights
• Confirms:
• Vue 3 component library
• Theme overrides with no extra CSS toolchains
• Documentation hosted at www.naiveui.com
• CI publishes to npm registry and OSS CDN for static assets
Detail & thoroughness
• Essential folder’s role (src, demo, build, scripts, playground)
• Don’t overcomplicate: isolate major components and their interactions
• Flows (development → build → test → publish → consume) are visible