poveste 0.3.3 → 0.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +46 -5
- package/package.json +5 -5
package/README.md
CHANGED
|
@@ -1,11 +1,52 @@
|
|
|
1
|
-
#
|
|
1
|
+
# poveste
|
|
2
2
|
|
|
3
3
|
> Fast and beautiful interactive component playgrounds
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
Poveste builds a browsable *book* of stories from your components, powered by
|
|
6
|
+
[Vite](https://vite.dev). It is a community-maintained successor to
|
|
7
|
+
[histoire](https://github.com/histoire-dev/histoire).
|
|
6
8
|
|
|
9
|
+
## Install
|
|
10
|
+
|
|
11
|
+
Install `poveste` alongside the plugin for your framework:
|
|
12
|
+
|
|
13
|
+
```shell
|
|
14
|
+
pnpm i -D poveste @poveste/plugin-vue # Vue 3
|
|
15
|
+
pnpm i -D poveste @poveste/plugin-svelte # Svelte 5 and SvelteKit
|
|
16
|
+
pnpm i -D poveste @poveste/plugin-nuxt # Nuxt 4
|
|
7
17
|
```
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
18
|
+
|
|
19
|
+
Then create a `poveste.config.ts` in your project root:
|
|
20
|
+
|
|
21
|
+
```ts
|
|
22
|
+
import { HstVue } from '@poveste/plugin-vue'
|
|
23
|
+
import { defineConfig } from 'poveste'
|
|
24
|
+
|
|
25
|
+
export default defineConfig({
|
|
26
|
+
plugins: [
|
|
27
|
+
HstVue(),
|
|
28
|
+
],
|
|
29
|
+
})
|
|
11
30
|
```
|
|
31
|
+
|
|
32
|
+
## Commands
|
|
33
|
+
|
|
34
|
+
| | |
|
|
35
|
+
| --- | --- |
|
|
36
|
+
| `poveste dev` | development server with hot reload |
|
|
37
|
+
| `poveste build` | build the book for production |
|
|
38
|
+
| `poveste preview` | serve the built book |
|
|
39
|
+
|
|
40
|
+
Run `npx poveste --help` for the full list of options.
|
|
41
|
+
|
|
42
|
+
## Requirements
|
|
43
|
+
|
|
44
|
+
Node `>=26` and Vite `^8.0.0`. See
|
|
45
|
+
[supported versions](https://poveste.dev/guide/getting-started.html#supported-versions) for
|
|
46
|
+
what proves each range.
|
|
47
|
+
|
|
48
|
+
## Links
|
|
49
|
+
|
|
50
|
+
- [Documentation](https://poveste.dev)
|
|
51
|
+
- [Migrating from histoire](https://poveste.dev/guide/migration-from-histoire.html)
|
|
52
|
+
- [GitHub](https://github.com/poveste-dev/poveste)
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "poveste",
|
|
3
3
|
"type": "module",
|
|
4
|
-
"version": "0.
|
|
4
|
+
"version": "0.5.0",
|
|
5
5
|
"description": "A fast story book powered by Vite",
|
|
6
6
|
"author": {
|
|
7
7
|
"name": "Sorin Gitlan"
|
|
@@ -68,10 +68,10 @@
|
|
|
68
68
|
"sirv": "^3.0.0",
|
|
69
69
|
"unhead": "^3.1.0",
|
|
70
70
|
"vite-node": "^6.0.0",
|
|
71
|
-
"@poveste/app": "^0.
|
|
72
|
-
"@poveste/
|
|
73
|
-
"@poveste/
|
|
74
|
-
"@poveste/vendors": "^0.
|
|
71
|
+
"@poveste/app": "^0.5.0",
|
|
72
|
+
"@poveste/controls": "^0.5.0",
|
|
73
|
+
"@poveste/shared": "^0.5.0",
|
|
74
|
+
"@poveste/vendors": "^0.5.0"
|
|
75
75
|
},
|
|
76
76
|
"devDependencies": {
|
|
77
77
|
"@types/fs-extra": "^11.0.4",
|