Skip to content

Commit

Permalink
docs(readme): update
Browse files Browse the repository at this point in the history
  • Loading branch information
craftzdog committed Oct 22, 2024
1 parent 2484039 commit fd456ac
Showing 1 changed file with 4 additions and 17 deletions.
21 changes: 4 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,9 @@
# Default Light UI Theme for Inkdrop

Inkdrop's UI elements are styled based on [Semantic UI](http://semantic-ui.com/).
It's mostly common in customizing the theme with it, so [their documentation](http://learnsemantic.com/) is very helpful to get started.
> [!NOTE]
> Do not fork this repository to create your own theme. Please read the documentation linked below.
Read [the documentation](https://developers.inkdrop.app/guides/create-a-theme) for detailed instructions.

## How to build
The default light UI theme for Inkdrop.

```
npm install
npm build
```

## Which files to edit
Read [the documentation](https://developers.inkdrop.app/guides/create-a-theme) for detailed instructions.

- `src/site/globals/site.variables`
- Variables for Inkdrop-specific components
- `src/site/globals/site.overrides`
- Declarations of CSS variables
- `src/themes/default/globals/site.variables`
- Common variables

0 comments on commit fd456ac

Please sign in to comment.