diff --git a/README.md b/README.md index 13c8961cdc..e41828d79e 100644 --- a/README.md +++ b/README.md @@ -34,11 +34,11 @@ Play with the editor @ [https://playground.blocknotejs.org/](https://playground. [![npm version](https://badge.fury.io/js/%40blocknote%2Freact.svg)](https://badge.fury.io/js/%40blocknote%2Freact) ```typescript -import { BlockNoteView, useBlockNote } from "@blocknote/react"; +import { BlockNoteView, useCreateBlockNote } from "@blocknote/react"; import "@blocknote/react/style.css"; function App() { - const editor = useBlockNote({ + const editor = useCreateBlockNote({ onEditorContentChange: (editor) => { // Log the document to console on every update console.log(editor.getJSON()); diff --git a/docs/api/og.tsx b/docs/api/og.tsx.bak similarity index 99% rename from docs/api/og.tsx rename to docs/api/og.tsx.bak index b7794f6e1b..dd02f0b647 100644 --- a/docs/api/og.tsx +++ b/docs/api/og.tsx.bak @@ -1,12 +1,11 @@ import { ImageResponse } from "@vercel/og"; -import React from "react"; export const config = { runtime: "edge", }; const font = fetch( - new URL("../docs/public/fonts/Gilroy-Regular.ttf", import.meta.url) + new URL("../../assets/fonts/Gilroy-Regular.ttf", import.meta.url), ).then((res) => res.arrayBuffer()); export default async function handler(request: { url: string }) { diff --git a/docs/public/fonts/Gilroy-Bold.ttf b/docs/assets/fonts/Gilroy-Bold.ttf similarity index 100% rename from docs/public/fonts/Gilroy-Bold.ttf rename to docs/assets/fonts/Gilroy-Bold.ttf diff --git a/docs/public/fonts/Gilroy-ExtraBold.ttf b/docs/assets/fonts/Gilroy-ExtraBold.ttf similarity index 100% rename from docs/public/fonts/Gilroy-ExtraBold.ttf rename to docs/assets/fonts/Gilroy-ExtraBold.ttf diff --git a/docs/public/fonts/Gilroy-Medium.ttf b/docs/assets/fonts/Gilroy-Medium.ttf similarity index 100% rename from docs/public/fonts/Gilroy-Medium.ttf rename to docs/assets/fonts/Gilroy-Medium.ttf diff --git a/docs/public/fonts/Gilroy-Regular.ttf b/docs/assets/fonts/Gilroy-Regular.ttf similarity index 100% rename from docs/public/fonts/Gilroy-Regular.ttf rename to docs/assets/fonts/Gilroy-Regular.ttf diff --git a/docs/public/fonts/Gilroy-SemiBold.ttf b/docs/assets/fonts/Gilroy-SemiBold.ttf similarity index 100% rename from docs/public/fonts/Gilroy-SemiBold.ttf rename to docs/assets/fonts/Gilroy-SemiBold.ttf diff --git a/docs/public/fonts/gilroy-bold.woff2 b/docs/assets/fonts/gilroy-bold.woff2 similarity index 100% rename from docs/public/fonts/gilroy-bold.woff2 rename to docs/assets/fonts/gilroy-bold.woff2 diff --git a/docs/public/fonts/gilroy-extrabold.woff2 b/docs/assets/fonts/gilroy-extrabold.woff2 similarity index 100% rename from docs/public/fonts/gilroy-extrabold.woff2 rename to docs/assets/fonts/gilroy-extrabold.woff2 diff --git a/docs/public/fonts/gilroy-medium.woff2 b/docs/assets/fonts/gilroy-medium.woff2 similarity index 100% rename from docs/public/fonts/gilroy-medium.woff2 rename to docs/assets/fonts/gilroy-medium.woff2 diff --git a/docs/public/fonts/gilroy-regular.woff2 b/docs/assets/fonts/gilroy-regular.woff2 similarity index 100% rename from docs/public/fonts/gilroy-regular.woff2 rename to docs/assets/fonts/gilroy-regular.woff2 diff --git a/docs/public/fonts/gilroy-semibold.woff2 b/docs/assets/fonts/gilroy-semibold.woff2 similarity index 100% rename from docs/public/fonts/gilroy-semibold.woff2 rename to docs/assets/fonts/gilroy-semibold.woff2 diff --git a/docs/components/pages/landing/hero/Demo.tsx b/docs/components/pages/landing/hero/Demo.tsx index 6d7a6d472c..c2ad2fff55 100644 --- a/docs/components/pages/landing/hero/Demo.tsx +++ b/docs/components/pages/landing/hero/Demo.tsx @@ -1,5 +1,5 @@ import { uploadToTmpFilesDotOrg_DEV_ONLY } from "@blocknote/core"; -import { BlockNoteView, useBlockNote } from "@blocknote/react"; +import { BlockNoteView, useCreateBlockNote } from "@blocknote/react"; import "@blocknote/react/style.css"; import { useMemo } from "react"; import YPartyKitProvider from "y-partykit/provider"; @@ -53,11 +53,7 @@ function getUTCDateYYYYMMDD() { return `${year}${formattedMonth}${formattedDay}`; } -export function ReactBlockNote(props: { - theme: "light" | "dark"; -}) { - - +export function ReactBlockNote(props: { theme: "light" | "dark" }) { const [doc, provider] = useMemo(() => { console.log("create"); const doc = new Y.Doc(); @@ -70,7 +66,7 @@ export function ReactBlockNote(props: { return [doc, provider]; }, []); - const editor = useBlockNote( + const editor = useCreateBlockNote( { collaboration: { provider, diff --git a/docs/next.config.mjs b/docs/next.config.mjs index a07f955480..21fb90daa6 100644 --- a/docs/next.config.mjs +++ b/docs/next.config.mjs @@ -20,19 +20,20 @@ const withAnalyzer = analyzer({ enabled: false }); const nextConfig = withAnalyzer( withNextra({ + // transpilePackages: ["@blocknote/example-react-custom-styles"], images: { remotePatterns: [ { - protocol: 'https', - hostname: 'avatars.githubusercontent.com', - port: '', - pathname: '/u/**', + protocol: "https", + hostname: "avatars.githubusercontent.com", + port: "", + pathname: "/u/**", }, { - protocol: 'https', - hostname: 'github.com', - port: '', - pathname: '/**', + protocol: "https", + hostname: "github.com", + port: "", + pathname: "/**", }, ], }, @@ -55,14 +56,16 @@ const nextConfig = withAnalyzer( vendor: { test: (module) => { // console.log(module.resource); - if (module.resource?.includes("blocknote") || module.resource?.includes("mantine")) { - + if ( + module.resource?.includes("blocknote") || + module.resource?.includes("mantine") + ) { return true; } return false; }, - name: 'blocknotechunk', - chunks: 'all', + name: "blocknotechunk", + chunks: "all", }, }, }; @@ -77,7 +80,7 @@ const nextConfig = withAnalyzer( // "@blocknote/react": path.resolve(__dirname, "../packages/react/src/"), }; }, - }) + }), ); export default nextConfig; diff --git a/docs/package.json b/docs/package.json index 6b4d3ecdc3..8ec05f7036 100644 --- a/docs/package.json +++ b/docs/package.json @@ -4,7 +4,7 @@ "private": true, "scripts": { "dev": "next dev", - "build": "next build", + "docs:build": "next build", "start": "next start", "lint": "next lint" }, @@ -12,7 +12,7 @@ "@blocknote/core": "*", "@blocknote/react": "*", "@headlessui/react": "^1.7.18", - "@mantine/core": "^7.4.2", + "@mantine/core": "^7.5.0", "@next/bundle-analyzer": "^14.1.0", "@vercel/og": "^0.6.2", "classnames": "2.3.2", diff --git a/docs/pages/docs/_meta.json b/docs/pages/docs/_meta.json index 532c9e4ed2..9d5049f9ce 100644 --- a/docs/pages/docs/_meta.json +++ b/docs/pages/docs/_meta.json @@ -1,8 +1,9 @@ { - "index": "Introduction", - "quickstart":"", + "quickstart": "Quickstart", + "editor-basics": "Editor Basics", "editor-api": "Editor API", + "styling-theming": "Styling & Theming", "ui-components": "UI Components", "custom-schemas": "Custom Schemas", "advanced": "Advanced", diff --git a/docs/pages/docs/advanced/nextjs.mdx b/docs/pages/docs/advanced/nextjs.mdx index 8e0bbc3119..8b20b3d13f 100644 --- a/docs/pages/docs/advanced/nextjs.mdx +++ b/docs/pages/docs/advanced/nextjs.mdx @@ -13,13 +13,13 @@ Make sure to use BlockNote in a [Client Component](https://nextjs.org/docs/getti ```typescript jsx "use client"; // this registers as a Client Component -import { BlockNoteView, useBlockNote } from "@blocknote/react"; +import { BlockNoteView, useCreateBlockNote } from "@blocknote/react"; import "@blocknote/react/style.css"; // Our component we can reuse later export default function Editor() { // Creates a new editor instance. - const editor = useBlockNote({}); + const editor = useCreateBlockNote(); // Renders the editor instance using a React component. return ; diff --git a/docs/pages/docs/advanced/real-time-collaboration.mdx b/docs/pages/docs/advanced/real-time-collaboration.mdx index f51641b727..d2559acc02 100644 --- a/docs/pages/docs/advanced/real-time-collaboration.mdx +++ b/docs/pages/docs/advanced/real-time-collaboration.mdx @@ -9,7 +9,11 @@ path: /docs/real-time-collaboration Let's see how you can add Multiplayer capabilities to your BlockNote setup, and allow real-time collaboration between users (similar to Google Docs): -text editing collaboration +text editing collaboration _Try the live demo on the [homepage](https://www.blocknotejs.org)_ @@ -23,7 +27,7 @@ import { WebrtcProvider } from "y-webrtc"; const doc = new Y.Doc(); const provider = new WebrtcProvider("my-document-id", doc); // setup a yjs provider (explained below) -const editor = useBlockNote({ +const editor = useCreateBlockNote({ // ... collaboration: { // The Yjs Provider responsible for transporting updates: @@ -61,9 +65,14 @@ Liveblocks provides a hosted back-end for Yjs which allows you to download and s npx create-liveblocks-app@latest --example nextjs-yjs-blocknote-advanced ``` -