@charcoal-ui ― PIXIV Design System monorepo
This is the monorepo for the @charcoal-ui packages by pixiv.
How to use
See our documentation, or README of each package in /packages.
NPM Packages
| package | version |
|---|---|
| @charcoal-ui/foundation |  |
| @charcoal-ui/icons |  |
| @charcoal-ui/icons-cli |  |
| @charcoal-ui/react |  |
| @charcoal-ui/react-sandbox |  |
| @charcoal-ui/styled |  |
| @charcoal-ui/tailwind-config |  |
| @charcoal-ui/tailwind-diff |  |
| @charcoal-ui/theme |  |
| @charcoal-ui/utils |  |
Contribution
Setup
Requires yarn and nodenv.
nodenv install `cat .node-version`
yarn installDevelopment
Start the development server on http://localhost:6006
yarn build
yarn storybook
If you want to start development for documentation site, run the following command and go to http://localhost:5000
yarn website
Commit
@charcoal-ui is using commintlint and following the Conventional Commits rules.