You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+23-6Lines changed: 23 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,12 +3,18 @@
3
3
Directory structure:
4
4
5
5
```
6
-
blocknote
7
-
├── packages/core - The core of the editor
8
-
├── packages/react - The main library for use in React apps
9
-
├── examples/editor - Example React app that embeds the editor
10
-
├── examples/vanilla - An advanced example if you don't want to use React or want to build your own UI components
11
-
└── tests - Playwright end to end tests
6
+
BlockNote
7
+
├── packages/core - The core of the editor, which includes all logic to get the editor running in vanilla JS.
8
+
├── packages/react - A React wrapper and UI for the editor. Requires additional components for the UI.
9
+
├── packages/ariakit - UI components for the `react` package, made with Ariakit.
10
+
├── packages/mantine - UI components for the `react` package, made with Mantine.
11
+
├── packages/shadcn - UI components for the `react` package, made with Shadcn.
12
+
├── packages/server-util - Utilities for converting BlockNote documents into static HTML for server-side rendering.
13
+
├── packages/dev-scripts - A set of tools for converting example editor setups into components for the BlockNote website.
14
+
├── examples - Example editor setups used for demos in the BlockNote website and playground.
15
+
├── docs - Code for the BlockNote website.
16
+
├── playground - A basic page where you can quickly test each of the example editor setups.
17
+
└── tests - Playwright end to end tests.
12
18
```
13
19
14
20
An introduction into the BlockNote Prosemirror schema can be found in [packages/core/src/pm-nodes/README.md](https://github.com/TypeCellOS/BlockNote/blob/main/packages/core/src/pm-nodes/README.md).
@@ -29,3 +35,14 @@ To run the project, open the command line in the project's root directory and en
29
35
- Add the dependency to the relevant `package.json` file (packages/xxx/package.json)
30
36
- run `npm run install-new-packages`
31
37
- Double check `package-lock.json` to make sure only the relevant packages have been affected
0 commit comments