README.md

@sieutoc/themes

A theme collection for Sieutoc site generator.

Usage

Using pnpm (Recommended):

pnpm i -E @sieutoc/themes

Then either use it directly with Chakra's theme Provider,

import themes from '@sieutoc/themes';
...
<ThemeProvider theme={themes['minimalist']}>

or extend it with your own theme.

import themes from '@sieutoc/themes';
...
const baseTheme = themes['minimalist'];

export const theme = extendTheme(baseTheme, yourCustomised);

Developing

Clone the project

git clone [email protected]:websitesieutoc/themes.git

Go to the project directory

cd themes

Install dependencies

pnpm install

Start the server

pnpm dev

Generators

We use plop for generating new theme.

// At the root of themes directory, run:
pnpm generate theme

After that, answer the prompt with a theme name, plop will generate a blank theme starter.

Release

We use changeset and GitHub Actions to auto generate new release PR.

After some development steps, and you think it's good to releaes, simply run:

pnpm changeset

A prompt will ask you for a release name, enter a good message then commit and push it.

Then push the changes. The changed commits will be automatically detected by GitHub Actions and it will be published to npm also automatically.