Skip to content

Commit

Permalink
Rspack example added (#3)
Browse files Browse the repository at this point in the history
* Rspack example added

* Readme fix
  • Loading branch information
krutoo authored Jan 27, 2025
1 parent 2b8e781 commit 124be15
Show file tree
Hide file tree
Showing 22 changed files with 6,267 additions and 2 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ MDX also supported as a story module (if your bundler is configured).

### Key features

- any bundle supported
- any bundler supported
- ability to show extra source files for story
- ability to fully customize showcase page and sandbox page

Expand Down
2 changes: 2 additions & 0 deletions examples/rspack/.gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
node_modules
.generated
21 changes: 21 additions & 0 deletions examples/rspack/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Example of using `@krutoo/showcase` with Rspack

This package contains example of documentation built with `@krutoo/showcase` and Rspack.

`@krutoo/showcase` is a simple alternative for Storybook that works with every bundler.

## How to run

```bash
# install dependencies
npm install

# if you want to use local version of `@krutoo/showcase`
npm run preparing

# if you want to use published version of `@krutoo/showcase` from NPM
npm add @krutoo/showcase

# run dev mode
npm run dev
```
Loading

0 comments on commit 124be15

Please sign in to comment.