[
React implementation of the Marigold Design System based on react-aria and Tailwind CSS.
Check out our latest release notes
Do you want to start using the Marigold Design System?
Then get started in the Marigold documentation.
Open a terminal and navigate to a folder of your choice:
- clone the project
git clone https://github.com/marigold-ui/marigold.git - navigate to the new folder
cd marigold - install the packages using
pnpm install
To start storybook use the following command in the root:
pnpm sb- open localhost:6006
To start documentation follow these steps:
- navigate to the documentation
cd docs - start the development server
pnpm dev - open localhost:3000.
| Command | Description |
|---|---|
| pnpm dev | Start the documentation app in dev mode. |
| pnpm start | Start the documentation app in production mode. |
| pnpm sb | Start Storybook using the components and system source folders. |
| pnpm build | Build components and theme packages. |
| pnpm build:docs | Build the documentation app. |
| pnpm build:sb | Build the Storybook configuration. |
| pnpm build:themes | Build all theme packages. |
| pnpm registry | Run the documentation registry task. |
| pnpm build:component-props | Generate/build component props tables for the docs. |
| pnpm test | Run tests with Vitest. |
| pnpm test:coverage | Run tests with coverage. |
| pnpm test:ci | Run tests for CI. |
| pnpm test:sb | Run Storybook component tests. |
| pnpm clean | Remove node_modules, dist, .next, .turbo, coverage, and storybook-static directories. |
| pnpm clean:build | Remove dist folders and coverage reports. |
| pnpm lint | Lint the repository with ESLint. |
| pnpm format | Format files with Prettier. |
| pnpm format:fix | Format and attempt to fix with Prettier. |
| pnpm typecheck | Build docs, then run TypeScript type checking (no emit). |
| pnpm typecheck:only | Run TypeScript type checking only (no emit). |
| pnpm contributor | Run the all-contributors CLI. |
| pnpm changeset | Run the Changesets CLI. |
Thanks goes to these wonderful people (emoji key):
This project follows the all-contributors specification. Contributions of any kind welcome!