mirror of
https://github.com/ueberdosis/tiptap.git
synced 2024-12-13 01:19:01 +08:00
27 lines
1.2 KiB
Markdown
27 lines
1.2 KiB
Markdown
# Document
|
||
[](https://www.npmjs.com/package/@tiptap/extension-document)
|
||
[](https://npmcharts.com/compare/@tiptap/extension-document?minimal=true)
|
||
|
||
**The `Document` extension is required**, no matter what you build with tiptap. It’s a so called “topNode”, a node that’s the home to all other nodes. Think of it like the `<body>` tag for your document.
|
||
|
||
The node is very tiny though. It defines a name of the node (`document`), is configured to be a top node (`topNode: true`) and that it can contain multiple other nodes (`block`). That’s all. But have a look yourself:
|
||
|
||
:::warning Breaking Change from 1.x → 2.x
|
||
tiptap 1 tried to hide that node from you, but it has always been there. You have to explicitly import it from now on (or use `defaultExtensions()`).
|
||
:::
|
||
|
||
## Installation
|
||
```bash
|
||
# with npm
|
||
npm install @tiptap/extension-document
|
||
|
||
# with Yarn
|
||
yarn add @tiptap/extension-document
|
||
```
|
||
|
||
## Source code
|
||
[packages/extension-document/](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-document/)
|
||
|
||
## Usage
|
||
<demo name="Nodes/Document" highlight="10,28" />
|