Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
14 changes: 7 additions & 7 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,14 +11,14 @@ jobs:
name: Build
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/checkout@v3

- uses: actions/setup-node@v4
- uses: actions/setup-node@v3
with:
node-version: "20.x"
node-version: "18.x"

- name: Cache node modules
uses: actions/cache@v4
uses: actions/cache@v3
env:
cache-name: cache-node-modules
with:
Expand All @@ -32,7 +32,7 @@ jobs:

- name: cache playwright
id: playwright-cache
uses: actions/cache@v4
uses: actions/cache@v3
with:
path: ~/.cache/ms-playwright
key: pw-new-${{ runner.os }}-${{ hashFiles('**/package-lock.json') }}
Expand Down Expand Up @@ -70,7 +70,7 @@ jobs:
working-directory: ./tests
run: npx playwright test

- uses: actions/upload-artifact@v4
- uses: actions/upload-artifact@v3
if: always()
with:
name: playwright-report
Expand All @@ -80,5 +80,5 @@ jobs:
- name: Upload webpack stats artifact (editor)
uses: relative-ci/agent-upload-artifact-action@v1
with:
webpackStatsFile: ./playground/dist/webpack-stats.json
webpackStatsFile: ./examples/editor/dist/webpack-stats.json
artifactName: relative-ci-artifacts-editor
2 changes: 1 addition & 1 deletion .nvmrc
Original file line number Diff line number Diff line change
@@ -1 +1 @@
v20.11.0
v18.16.0
26 changes: 15 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,45 +1,49 @@
<p align="center">
<a href="https://www.blocknotejs.org">
<img alt="TypeCell" src="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/TypeCellOS/BlockNote/raw/main/docs/public/img/logos/banner.svg?raw=true" width="300" />
<img alt="TypeCell" src="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/TypeCellOS/BlockNote/raw/main/packages/website/docs/public/img/logos/banner.svg?raw=true" width="300" />
</a>
</p>

<p align="center">
Welcome to BlockNote! The open source Block-Based
React rich text editor. Easily add a modern text editing experience to your app.
rich text editor. Easily add a modern text editing experience to your app.
</p>

<p align="center">
<a href="https://discord.gg/Qc2QTTH5dF"><img alt="Discord" src="https://img.shields.io/badge/Chat on discord%20-%237289DA.svg?&style=for-the-badge&logo=discord&logoColor=white"/></a>
<a href="https://discord.gg/Qc2QTTH5dF"><img alt="Discord" src="https://img.shields.io/badge/Chat on discord%20-%237289DA.svg?&style=for-the-badge&logo=discord&logoColor=white"/></a> <a href="https://matrix.to/#/#typecell-space:matrix.org"><img alt="Matrix" src="https://img.shields.io/badge/Chat on matrix%20-%23000.svg?&style=for-the-badge&logo=matrix&logoColor=white"/></a>
</p>

<p align="center">
<a href="https://www.blocknotejs.org">
Homepage
</a> - <a href="https://www.blocknotejs.org/docs/introduction">
Documentation
Introduction
</a> - <a href="https://www.blocknotejs.org/docs/quickstart">
Quickstart
</a>- <a href="https://www.blocknotejs.org/docs/examples">
Examples
Documentation
</a>
</p>

# Live demo

See our homepage @ [https://www.blocknotejs.org](https://www.blocknotejs.org/) or browse the [examples](https://www.blocknotejs.org/examples).
Play with the editor @ [https://playground.blocknotejs.org/](https://playground.blocknotejs.org/).

(Source in [examples](/examples))

# Example code (React)

[![npm version](https://badge.fury.io/js/%40blocknote%2Freact.svg)](https://badge.fury.io/js/%40blocknote%2Freact)

```typescript
import { BlockNoteView, useCreateBlockNote } from "@blocknote/react";
import "@blocknote/core/fonts/inter.css";
import { BlockNoteView, useBlockNote } from "@blocknote/react";
import "@blocknote/react/style.css";

function App() {
const editor = useCreateBlockNote();
const editor = useBlockNote({
onEditorContentChange: (editor) => {
// Log the document to console on every update
console.log(editor.getJSON());
},
});

return <BlockNoteView editor={editor} />;
}
Expand Down
4 changes: 0 additions & 4 deletions docs/.env.local.example

This file was deleted.

3 changes: 0 additions & 3 deletions docs/.eslintrc.json

This file was deleted.

36 changes: 0 additions & 36 deletions docs/.gitignore

This file was deleted.

36 changes: 0 additions & 36 deletions docs/README.md

This file was deleted.

2 changes: 0 additions & 2 deletions docs/app/api/auth/[...nextauth]/route.ts

This file was deleted.

Binary file removed docs/app/favicon.ico
Binary file not shown.
33 changes: 0 additions & 33 deletions docs/app/globals.css

This file was deleted.

22 changes: 0 additions & 22 deletions docs/app/layout.tsx

This file was deleted.

113 changes: 0 additions & 113 deletions docs/app/page.tsx.bak

This file was deleted.

Loading