Skip to content

Commit 72c3678

Browse files
docs: update contribution.md to include a table of packages (#931)
* chore: update contribution.md to include a table of pacakges * chore: fix package descriptions * Updated `CONTRIBUTING.md` --------- Co-authored-by: matthewlipski <[email protected]>
1 parent ed82ae5 commit 72c3678

File tree

1 file changed

+23
-6
lines changed

1 file changed

+23
-6
lines changed

CONTRIBUTING.md

Lines changed: 23 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,18 @@
33
Directory structure:
44

55
```
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.
1218
```
1319

1420
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
2935
- Add the dependency to the relevant `package.json` file (packages/xxx/package.json)
3036
- run `npm run install-new-packages`
3137
- Double check `package-lock.json` to make sure only the relevant packages have been affected
38+
39+
## Packages:
40+
41+
| Package | Size | Version |
42+
|--------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------|
43+
| [@blocknote/core](https://github.com/TypeCellOS/BlockNote/tree/main/packages/core) | <a href="https://bundlephobia.com/result?p=@blocknote/core@latest"><img src="https://img.shields.io/bundlephobia/minzip/@blocknote/core?color=%238ab4f8&label=gzip%20size"></a> | <a href="https://www.npmjs.com/package/@blocknote/core"><img src="https://img.shields.io/npm/v/@blocknote/core.svg?color=%23c1a8e2"></a> |
44+
| [@blocknote/react](https://github.com/TypeCellOS/BlockNote/tree/main/packages/react) | <a href="https://bundlephobia.com/result?p=@blocknote/react@latest"><img src="https://img.shields.io/bundlephobia/minzip/@blocknote/react?color=%238ab4f8&label=gzip%20size"></a> | <a href="https://www.npmjs.com/package/@blocknote/react"><img src="https://img.shields.io/npm/v/@blocknote/react?color=%23c1a8e2"></a> |
45+
| [@blocknote/ariakit](https://github.com/TypeCellOS/BlockNote/tree/main/packages/ariakit) | <a href="https://bundlephobia.com/result?p=@blocknote/ariakit@latest"><img src="https://img.shields.io/bundlephobia/minzip/@blocknote/ariakit?color=%238ab4f8&label=gzip%20size"></a> | <a href="https://www.npmjs.com/package/@blocknote/ariakit"><img src="https://img.shields.io/npm/v/@blocknote/ariakit?color=%23c1a8e2"></a> |
46+
| [@blocknote/mantine](https://github.com/TypeCellOS/BlockNote/tree/main/packages/mantine) | <a href="https://bundlephobia.com/result?p=@blocknote/mantine@latest"><img src="https://img.shields.io/bundlephobia/minzip/@blocknote/mantine?color=%238ab4f8&label=gzip%20size"></a> | <a href="https://www.npmjs.com/package/@blocknote/mantine"><img src="https://img.shields.io/npm/v/@blocknote/mantine?color=%23c1a8e2"></a> |
47+
| [@blocknote/shadcn](https://github.com/TypeCellOS/BlockNote/tree/main/packages/shadcn) | <a href="https://bundlephobia.com/result?p=@blocknote/shadcn@latest"><img src="https://img.shields.io/bundlephobia/minzip/@blocknote/shadcn?color=%238ab4f8&label=gzip%20size"></a> | <a href="https://www.npmjs.com/package/@blocknote/shadcn"><img src="https://img.shields.io/npm/v/@blocknote/shadcn?color=%23c1a8e2"></a> |
48+
| [@blocknote/server-util](https://github.com/TypeCellOS/BlockNote/tree/main/packages/server-util) | <a href="https://bundlephobia.com/result?p=@blocknote/server-util@latest"><img src="https://img.shields.io/bundlephobia/minzip/@blocknote/server-util?color=%238ab4f8&label=gzip%20size"></a> | <a href="https://www.npmjs.com/package/@blocknote/server-util"><img src="https://img.shields.io/npm/v/@blocknote/server-util?color=%23c1a8e2"></a> |

0 commit comments

Comments
 (0)