@notionhq/custom-blocks-dev-shell 0.1.4 → 0.1.6
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 +8 -5
- package/dist/assets/index-CDRf4GRS.js +9 -0
- package/dist/assets/index-x1e1jng3.css +2 -0
- package/dist/index.html +2 -2
- package/dist-cli/serve-ui.js +1 -1
- package/docs/bindings.md +41 -0
- package/package.json +2 -2
- package/dist/assets/index-7cNoc5dY.js +0 -9
- package/dist/assets/index-CzXh8_H1.css +0 -2
package/README.md
CHANGED
|
@@ -1,24 +1,24 @@
|
|
|
1
1
|
# Notion custom blocks dev shell
|
|
2
2
|
|
|
3
|
-
A local
|
|
3
|
+
A local dev shell for Notion custom block workers. It builds your worker,
|
|
4
4
|
reads the manifest declared by your `worker.customBlock(...)` calls, serves each
|
|
5
5
|
block with your project's own Vite, and renders them in a mock Notion host with
|
|
6
6
|
sample data sources you can bind against.
|
|
7
7
|
|
|
8
8
|
## Usage
|
|
9
9
|
|
|
10
|
-
From anywhere inside your worker project:
|
|
10
|
+
From anywhere inside your worker project, with the Notion CLI (v0.20.0+):
|
|
11
11
|
|
|
12
12
|
```bash
|
|
13
|
-
|
|
13
|
+
ntn customblocks dev
|
|
14
14
|
```
|
|
15
15
|
|
|
16
16
|
Then open http://localhost:9873.
|
|
17
17
|
|
|
18
18
|
Options:
|
|
19
19
|
|
|
20
|
-
-
|
|
21
|
-
|
|
20
|
+
- `[path]` — point at a worker directory explicitly instead of detecting one
|
|
21
|
+
from the current directory.
|
|
22
22
|
- `--port <port>` — serve the shell UI somewhere other than 9873.
|
|
23
23
|
- `--block-base-port <port>` — first port handed to the per-block dev servers
|
|
24
24
|
(default 9876; blocks count up from there).
|
|
@@ -28,6 +28,9 @@ Options:
|
|
|
28
28
|
One page per topic, shipped in this package's `docs/` so they're readable
|
|
29
29
|
from `node_modules`:
|
|
30
30
|
|
|
31
|
+
- [`docs/bindings.md`](./docs/bindings.md) — connecting blocks to data
|
|
32
|
+
sources: auto-mapping and compatibility rules, initialization, and live
|
|
33
|
+
rebinding.
|
|
31
34
|
- [`docs/data-sources.md`](./docs/data-sources.md) — local data sources: the
|
|
32
35
|
`src/data/*.json` file format, value shapes per property type, validation,
|
|
33
36
|
and how missing sources are materialized from the worker's declared
|