@rookie4show/onmyoji-flow 0.1.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 +49 -0
- package/dist/onmyoji-flow.css +1 -0
- package/dist/onmyoji-flow.es.js +59888 -0
- package/dist/onmyoji-flow.es.js.map +1 -0
- package/dist/onmyoji-flow.umd.js +269 -0
- package/dist/onmyoji-flow.umd.js.map +1 -0
- package/package.json +83 -0
package/README.md
ADDED
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
# onmyoji-flow
|
|
2
|
+
|
|
3
|
+
`onmyoji-flow` is a standalone flow editor and embeddable Vue component package.
|
|
4
|
+
|
|
5
|
+
## Package
|
|
6
|
+
|
|
7
|
+
- npm name: `@rookie4show/onmyoji-flow`
|
|
8
|
+
- style entry: `@rookie4show/onmyoji-flow/style.css`
|
|
9
|
+
|
|
10
|
+
## Local Development
|
|
11
|
+
|
|
12
|
+
```bash
|
|
13
|
+
npm install
|
|
14
|
+
npm run dev
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
## Build
|
|
18
|
+
|
|
19
|
+
```bash
|
|
20
|
+
# library build for npm publish
|
|
21
|
+
npm run build:lib
|
|
22
|
+
|
|
23
|
+
# app build (output: dist-app)
|
|
24
|
+
npm run build:app
|
|
25
|
+
|
|
26
|
+
# app build for GitHub Pages (/onmyoji-flow/, output: dist-app)
|
|
27
|
+
npm run build:pages
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
## Use as Vue Component
|
|
31
|
+
|
|
32
|
+
```ts
|
|
33
|
+
import { YysEditorEmbed, YysEditorPreview } from '@rookie4show/onmyoji-flow'
|
|
34
|
+
import '@rookie4show/onmyoji-flow/style.css'
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
## Publish to npm
|
|
38
|
+
|
|
39
|
+
```bash
|
|
40
|
+
npm login
|
|
41
|
+
npm run build:lib
|
|
42
|
+
npm publish
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
## Deploy to GitHub Pages
|
|
46
|
+
|
|
47
|
+
`build-pages.yml` is the only workflow now.
|
|
48
|
+
It builds on `master` branch push and deploys `dist-app` to GitHub Pages automatically.
|
|
49
|
+
In repository settings, set Pages source to `GitHub Actions`.
|