Skip to content
This repository was archived by the owner on Jul 3, 2024. It is now read-only.
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 16 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
# 👻 Bookit 👻

[Demo](https://bookit.leveluptutorials.com/book)

Docs (coming soon)

## The least spooky way to build your components.
## The least spooky way to build your components

Pronounced Boo-Kit or Book-It

Expand All @@ -18,3 +19,17 @@ A new Story environment with a different approach. Finely tuned to work directly
- Themeable
- Use your real data
- Simple

### How to install

1. Download or clone the Bookit repo
2. Copy the `book` folder into the 'routes' folder of your Svelte Kit project

### How to use

Anywhere in your app, you create a '*.story.svelte' to show a component. You can also create a 'stories' folder to organize your stories.

### '*.story.svelte' structure

- title: The title of the component
- parent: The category of the component