From a94856639fbd8e9ac4dca634bd4376778a2b1624 Mon Sep 17 00:00:00 2001 From: zakher Date: Tue, 16 Jul 2024 01:22:45 +0300 Subject: [PATCH 1/3] chore: update contribution.md to include a table of pacakges --- CONTRIBUTING.md | 23 ++++++++++++++++++----- 1 file changed, 18 insertions(+), 5 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 89b7151273..a7774ea5f1 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -4,11 +4,14 @@ Directory structure: ``` blocknote -├── packages/core - The core of the editor -├── packages/react - The main library for use in React apps -├── examples/editor - Example React app that embeds the editor -├── examples/vanilla - An advanced example if you don't want to use React or want to build your own UI components -└── tests - Playwright end to end tests +├── packages/core - The core of the editor +├── packages/react - The main library for use in React apps +├── packages/ariakit - AriaKit, a library for building accessible UI components +├── packages/mantine - Mantine, a library for building UI components +├── packages/shadcn - Shadcn, a library for building UI components +├── examples/editor - Example React app that embeds the editor +├── examples/vanilla - An advanced example if you don't want to use React or want to build your own UI components +└── tests - Playwright end to end tests ``` 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 +32,13 @@ To run the project, open the command line in the project's root directory and en - Add the dependency to the relevant `package.json` file (packages/xxx/package.json) - run `npm run install-new-packages` - Double check `package-lock.json` to make sure only the relevant packages have been affected + +## Packages: + +| Package | Size | Version | +| ---------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ | +| [@blocknote/core](https://github.com/TypeCellOS/BlockNote/tree/main/packages/core) | | | +| [@blocknote/react](https://github.com/TypeCellOS/BlockNote/tree/main/packages/react) | | | +| [@blocknote/ariakit](https://github.com/TypeCellOS/BlockNote/tree/main/packages/ariakit) | | | +| [@blocknote/mantine](https://github.com/TypeCellOS/BlockNote/tree/main/packages/mantine) | | | +| [@blocknote/shadcn](https://github.com/TypeCellOS/BlockNote/tree/main/packages/shadcn) | | | From ce304c63ecb36d72f42611c85f20a5b25c8b7a2c Mon Sep 17 00:00:00 2001 From: zakher Date: Tue, 16 Jul 2024 01:26:41 +0300 Subject: [PATCH 2/3] chore: fix package descriptions --- CONTRIBUTING.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index a7774ea5f1..ace78ad516 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,9 +6,9 @@ Directory structure: blocknote ├── packages/core - The core of the editor ├── packages/react - The main library for use in React apps -├── packages/ariakit - AriaKit, a library for building accessible UI components -├── packages/mantine - Mantine, a library for building UI components -├── packages/shadcn - Shadcn, a library for building UI components +├── packages/ariakit - For the BlockNoteView component made with ariakit +├── packages/mantine - For the BlockNoteView component made with mantine +├── packages/shadcn - For the BlockNoteView component made with shadcn ├── examples/editor - Example React app that embeds the editor ├── examples/vanilla - An advanced example if you don't want to use React or want to build your own UI components └── tests - Playwright end to end tests From ce2730f0714aa4f8489d4d655248d0da7363a897 Mon Sep 17 00:00:00 2001 From: matthewlipski Date: Thu, 18 Jul 2024 16:06:11 +0200 Subject: [PATCH 3/3] Updated `CONTRIBUTING.md` --- CONTRIBUTING.md | 36 ++++++++++++++++++++---------------- 1 file changed, 20 insertions(+), 16 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index ace78ad516..9159700782 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -3,15 +3,18 @@ Directory structure: ``` -blocknote -├── packages/core - The core of the editor -├── packages/react - The main library for use in React apps -├── packages/ariakit - For the BlockNoteView component made with ariakit -├── packages/mantine - For the BlockNoteView component made with mantine -├── packages/shadcn - For the BlockNoteView component made with shadcn -├── examples/editor - Example React app that embeds the editor -├── examples/vanilla - An advanced example if you don't want to use React or want to build your own UI components -└── tests - Playwright end to end tests +BlockNote +├── packages/core - The core of the editor, which includes all logic to get the editor running in vanilla JS. +├── packages/react - A React wrapper and UI for the editor. Requires additional components for the UI. +├── packages/ariakit - UI components for the `react` package, made with Ariakit. +├── packages/mantine - UI components for the `react` package, made with Mantine. +├── packages/shadcn - UI components for the `react` package, made with Shadcn. +├── packages/server-util - Utilities for converting BlockNote documents into static HTML for server-side rendering. +├── packages/dev-scripts - A set of tools for converting example editor setups into components for the BlockNote website. +├── examples - Example editor setups used for demos in the BlockNote website and playground. +├── docs - Code for the BlockNote website. +├── playground - A basic page where you can quickly test each of the example editor setups. +└── tests - Playwright end to end tests. ``` 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). @@ -35,10 +38,11 @@ To run the project, open the command line in the project's root directory and en ## Packages: -| Package | Size | Version | -| ---------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ | -| [@blocknote/core](https://github.com/TypeCellOS/BlockNote/tree/main/packages/core) | | | -| [@blocknote/react](https://github.com/TypeCellOS/BlockNote/tree/main/packages/react) | | | -| [@blocknote/ariakit](https://github.com/TypeCellOS/BlockNote/tree/main/packages/ariakit) | | | -| [@blocknote/mantine](https://github.com/TypeCellOS/BlockNote/tree/main/packages/mantine) | | | -| [@blocknote/shadcn](https://github.com/TypeCellOS/BlockNote/tree/main/packages/shadcn) | | | +| Package | Size | Version | +|--------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------| +| [@blocknote/core](https://github.com/TypeCellOS/BlockNote/tree/main/packages/core) | | | +| [@blocknote/react](https://github.com/TypeCellOS/BlockNote/tree/main/packages/react) | | | +| [@blocknote/ariakit](https://github.com/TypeCellOS/BlockNote/tree/main/packages/ariakit) | | | +| [@blocknote/mantine](https://github.com/TypeCellOS/BlockNote/tree/main/packages/mantine) | | | +| [@blocknote/shadcn](https://github.com/TypeCellOS/BlockNote/tree/main/packages/shadcn) | | | +| [@blocknote/server-util](https://github.com/TypeCellOS/BlockNote/tree/main/packages/server-util) | | |