About

Sépale is an open source, MIT licensed project, maintained on a volunteer basis. Components come first, as CSS classes or Svelte components, and the CSS after : a family to pick, a few parameters to tune. Every bug report, idea and pull request helps it grow.

Support

Ways to help

Report a bug

A component that renders wrong in a family, a theme that breaks a state, a prop the types reject ? An issue with the family, the theme and a screenshot is the most useful help.

Open an issue

Suggest a feature

A missing component, a variant a family lacks, a parameter worth exposing : describe it in an issue before writing code.

Browse issues

Improve the docs

Each component page of this site is written by hand, next to the decisions in docs/. A typo fix or a clearer example is a welcome pull request.

docs/

Find your way around

The repository is the source of the packages and of this site :

src/lib/components
The Svelte components, written by hand
src/scss/families
The families, each one directory: the whole of every component, and its themes
packages
The two npm packages, @sepale/style and @sepale/components
src/routes
This site, its theme generator and its component pages
docs
How a family is written, and the decisions behind Sépale
pnpm run dev                  # compile the families, run this site locally
pnpm run build:css            # compile the families and regenerate the registry
node scripts/shoot.mjs daisy  # screenshot a family's components

Contributing code

  1. Fork the repository and create a branch from main.
    git clone https://github.com/<you>/sepale
    cd sepale && pnpm install
    git checkout -b my-change
  2. Make your change, then look at it : run the site and walk the component in a light and a dark theme, with hover, focus, disabled and checked. A look is judged by rendering. To add a family, follow docs/families.md.
    pnpm run dev
  3. Check everything locally. It compiles every family and theme, then checks the types.
    pnpm run check
  4. Open a pull request against main.
Sponsor