Skip to content

docs: Fix broken links #618

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Mar 5, 2024
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
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/pages/docs/advanced/real-time-collaboration.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Let's see how you can add Multiplayer capabilities to your BlockNote setup, and

<img
style={{ maxWidth: "300px", border: "1px solid gray" }}
src="/img/features/collaboration.gif"
src="/img/features/collaboration_light.gif"
alt="text editing collaboration"
/>

Expand Down
8 changes: 4 additions & 4 deletions docs/pages/docs/custom-schemas.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,19 +12,19 @@ However, you can extend BlockNote and create custom schemas to support your own

Blocks are the main elements of a document, such as paragraphs, headings, lists, etc.

- [Learn how to create custom blocks for your BlockNote editor](/docs/custom-schemas/blocks)
- [Learn how to create custom blocks for your BlockNote editor](/docs/custom-schemas/custom-blocks)

## Custom Inline Content

Inline Content are elements that can be inserted inside a text block, such as links, mentions, tags, etc.

- [Learn how to create custom Inline Content for your BlockNote editor](/docs/custom-schemas/inline-content)
- [Learn how to create custom Inline Content for your BlockNote editor](/docs/custom-schemas/custom-inline-content)

## Custom Styles

Text Styles are properties that can be applied to a piece of text, such as bold, italic, underline, etc.

- [Learn how to add custom Styles to your BlockNote editor](/docs/custom-schemas/styles)
- [Learn how to add custom Styles to your BlockNote editor](/docs/custom-schemas/custom-styles)

## Creating your own schema

Expand Down Expand Up @@ -96,4 +96,4 @@ type MyPartialBlock = typeof schema.PartialBlock;

### Automatically override all default types (experimental)

Alternatively, the easiest way to get full type safety without any additional work is to override all default types with your custom schema, by using a custom type definition file. See this [example blocknote.d.ts](https://github.com/TypeCellOS/BlockNote/blob/main/examples/06-custom-schema/react-custom-styles/blocknote.d.ts.example). This is an experimental feature - we would love to hear your feedback on this approach.
Alternatively, the easiest way to get full type safety without any additional work is to override all default types with your custom schema, by using a custom type definition file. See this [example blocknote.d.ts](https://github.com/TypeCellOS/BlockNote/blob/main/examples/05-custom-schema/react-custom-styles/blocknote.d.ts.example). This is an experimental feature - we would love to hear your feedback on this approach.
2 changes: 1 addition & 1 deletion docs/pages/docs/custom-schemas/custom-inline-content.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ Defines the identifier of the custom inline content.

**`content`**

`styled` if your custom inline content should support [styled text content](/docs/editor-api/block-content#styled-text), `none` if not.
`styled` if your custom inline content should contain [`StyledText`](/docs/editor-basics/document-structure#inline-content-objects), `none` if not.

_In the mentions demo, we want each mention to be a single, non-editable element, so we set it to `"none"`._

Expand Down
10 changes: 5 additions & 5 deletions docs/pages/docs/editor-basics/document-structure.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -35,11 +35,11 @@ type Block = {

`id:` The block's ID. Multiple blocks cannot share a single ID, and a block will keep the same ID from when it's created until it's removed.

`type:` The block's type, such as a paragraph, heading, or list item. For an overview of built-in block types, see [Default Blocks](/docs/editor-basics/default-content-types#default-blocks).
`type:` The block's type, such as a paragraph, heading, or list item. For an overview of built-in block types, see [Default Blocks](/docs/editor-basics/default-schema#default-blocks).

`props:` The block's properties, which is a set of key/value pairs that further specify how the block looks and behaves. Different block types have different props - see [Default Blocks](/docs/editor-basics/default-content-types#default-blocks) for more.
`props:` The block's properties, which is a set of key/value pairs that further specify how the block looks and behaves. Different block types have different props - see [Default Blocks](/docs/editor-basics/default-schema#default-blocks) for more.

`content:` The block's rich text content, usually represented as an array of `InlineContent` objects. This does not include content from any nested blocks. Read on to [Inline Content](/docs/editor-basics/content-structure#inline-content) for more on this.
`content:` The block's rich text content, usually represented as an array of `InlineContent` objects. This does not include content from any nested blocks. Read on to [Inline Content](/docs/editor-basics/document-structure#inline-content) for more on this.

`children:` Any blocks nested inside the block. The nested blocks are also represented using `Block` objects.

Expand Down Expand Up @@ -71,9 +71,9 @@ The `styles` property is explained below.

### Other types of Block Content

While most blocks use an array of `InlineContent` objects to describe their content (e.g.: paragraphs, headings, list items). Some blocks, like [images](/docs/editor-basics/default-content-types#image), don't contain any rich text content, so their `content` fields will be `undefined`.
While most blocks use an array of `InlineContent` objects to describe their content (e.g.: paragraphs, headings, list items). Some blocks, like [images](/docs/editor-basics/default-schema#image), don't contain any rich text content, so their `content` fields will be `undefined`.

[Tables](/docs/editor-basics/default-content-types#table) are also different, as they contain `TableContent`. Here, each table cell is represented as an array of `InlineContent` objects:
[Tables](/docs/editor-basics/default-schema#table) are also different, as they contain `TableContent`. Here, each table cell is represented as an array of `InlineContent` objects:

```typescript
type TableContent = {
Expand Down
2 changes: 1 addition & 1 deletion docs/pages/docs/editor-basics/setup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ The hook takes two optional parameters:

`uploadFile`: A function which handles file uploads and eventually returns the URL to the uploaded file. Used for [Image blocks](/docs/editor-basics/default-schema#image).

`collaboration`: Options for enabling real-time collaboration. See [Collaboration](/docs/collaboration) for more info.
`collaboration`: Options for enabling real-time collaboration. See [Real-time Collaboration](/docs/advanced/real-time-collaboration) for more info.

`schema` (_advanced_): The editor schema if you want to extend your editor with custom blocks, styles, or inline content [Custom Schemas](/docs/custom-schemas).

Expand Down
8 changes: 4 additions & 4 deletions docs/pages/docs/ui-components.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,8 @@ path: /docs/ui-components

BlockNote includes a number of UI Components (like menus and toolbars) that can be completely customized:

- [Block Side Menu](/docs/side-menu)
- [Formatting Toolbar](/docs/formatting-toolbar)
- [Suggestion Menus](/docs/suggestion-menus)
- [Block Side Menu](/docs/ui-components/side-menu)
- [Formatting Toolbar](/docs/ui-components/formatting-toolbar)
- [Suggestion Menus](/docs/ui-components/suggestion-menus)
{/* - Hyperlink Toolbar */}
{/* - [Image Toolbar](/docs/image-toolbar) */}
{/* - [Image Toolbar](/docs/ui-components/image-toolbar) */}
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ In this example, we add an item to the Slash Menu, which adds a new block below

**Relevant Docs:**

- [Changing Slash Menu Items](/docs/ui-components/slash-menu#changing-slash-menu-items)
- [Changing Slash Menu Items](/docs/ui-components/suggestion-menus#changing-slash-menu-items)
- [Getting Text Cursor Position](/docs/editor-api/cursor-selections#getting-text-cursor-position)
- [Inserting New Blocks](/docs/editor-api/manipulating-blocks#inserting-new-blocks)
- [Editor Setup](/docs/editor-basics/setup)
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,5 @@ In this example, we replace the default Slash Menu component with a basic custom

**Relevant Docs:**

- [Replacing the Slash Menu Component](/docs/ui-components/slash-menu#replacing-the-slash-menu-component)
- [Replacing the Slash Menu Component](/docs/ui-components/suggestion-menus#replacing-the-suggestion-menu-component)
- [Editor Setup](/docs/editor-basics/setup)
2 changes: 1 addition & 1 deletion examples/02-ui-components/08-custom-ui/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,6 @@ In this example, we replace the default Formatting Toolbar using a custom React
- [Formatting Toolbar](/docs/ui-components/formatting-toolbar)
- [Manipulating Inline Content](/docs/editor-api/manipulating-inline-content)
- [Hooks](TODO)
- [Slash Menu](/docs/ui-components/slash-menu)
- [Slash Menu](/docs/ui-components/suggestion-menus#slash-menu)
- [Side Menu](/docs/ui-components/side-menu)
- [Editor Setup](/docs/editor-basics/setup)
2 changes: 1 addition & 1 deletion examples/05-custom-schema/01-alert-block/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,5 @@ In this example, we create a custom `Alert` block which is used to emphasize tex
**Relevant Docs:**

- [Custom Blocks](/docs/custom-schemas/custom-blocks)
- [Changing Slash Menu Items](/docs/ui-components/slash-menu#changing-slash-menu-items)
- [Changing Slash Menu Items](/docs/ui-components/suggestion-menus#changing-slash-menu-items)
- [Editor Setup](/docs/editor-basics/setup)
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,5 @@ In this example, we create a custom `Mention` inline content type which is used
**Relevant Docs:**

- [Custom Inline Content Types](/docs/custom-schemas/custom-inline-content)
- [Creating Suggestion Menus](/docs/ui-components/slash-menu#creating-suggestion-menus)
- [Creating Suggestion Menus](/docs/ui-components/suggestion-menus#creating-additional-suggestion-menus)
- [Editor Setup](/docs/editor-basics/setup)