Skip to content

Commit 124be15

Browse files
authored
Rspack example added (#3)
* Rspack example added * Readme fix
1 parent 2b8e781 commit 124be15

22 files changed

+6267
-2
lines changed

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ MDX also supported as a story module (if your bundler is configured).
1010

1111
### Key features
1212

13-
- any bundle supported
13+
- any bundler supported
1414
- ability to show extra source files for story
1515
- ability to fully customize showcase page and sandbox page
1616

examples/rspack/.gitignore

+2
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
node_modules
2+
.generated

examples/rspack/README.md

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Example of using `@krutoo/showcase` with Rspack
2+
3+
This package contains example of documentation built with `@krutoo/showcase` and Rspack.
4+
5+
`@krutoo/showcase` is a simple alternative for Storybook that works with every bundler.
6+
7+
## How to run
8+
9+
```bash
10+
# install dependencies
11+
npm install
12+
13+
# if you want to use local version of `@krutoo/showcase`
14+
npm run preparing
15+
16+
# if you want to use published version of `@krutoo/showcase` from NPM
17+
npm add @krutoo/showcase
18+
19+
# run dev mode
20+
npm run dev
21+
```

0 commit comments

Comments
 (0)