Skip to content

Commit 24517fb

Browse files
committed
docs: add packaging schema
1 parent 52ecefb commit 24517fb

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

adr/2025_06_13-packages.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# BlockNote Packages & Sub-Packages
2+
3+
## Core
4+
5+
The `@blocknote/core` package should contain everything needed to build a pure JS editor instance. It has no opinion on the UI layer, and is only concerned with the core editor functionality.
6+
7+
It contains sub-packages for:
8+
9+
- `@blocknote/core/blocks` - Contains the default blocks, inline content, styles and their implementations (excluding things like blockContainer, blockGroup, etc which are core to the editor but should not be part of the schema).
10+
- `@blocknote/core/blocks/header` - Contains the header block.
11+
- `@blocknote/core/blocks/code-block` - Contains the code block block.
12+
- etc...
13+
- `@blocknote/core/extensions` - Re-exports the extension packages below.
14+
- `@blocknote/core/extensions/comments` - Contains the comments extension.
15+
- `@blocknote/core/exporter` - Contains the exporter package.
16+
- `@blocknote/core/exporter/html` - Contains the html exporter package.
17+
- `@blocknote/core/exporter/markdown` - Contains the markdown exporter package.
18+
- `@blocknote/core/server-util` - Contains the server util package.
19+
- `@blocknote/core/locales` - Contains the locales package.
20+
21+
## React
22+
23+
The `@blocknote/react` package should contain everything needed to build a React editor instance. It has no opinion on the core editor functionality, and is only concerned with the React UI layer.
24+
25+
It contains sub-packages for:
26+
27+
- `@blocknote/react/editor` - Contains the editor package.
28+
- `@blocknote/react/comments` - Contains the comments package.
29+
- `@blocknote/react/table-handles` - Contains the table handles package.
30+
- etc... (need to figure out what needs to be exported vs. available and how coupled this all is)

0 commit comments

Comments
 (0)