mirror/tiptap
1
0
Fork 0
mirror of https://github.com/ueberdosis/tiptap.git synced 2025-01-18 06:03:22 +08:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

add more text to the getSchema documentation

Browse Source
This commit is contained in:
Hans Pagel 2020-09-04 11:59:38 +02:00
parent 49d413268b
commit fb3c009797
1 changed files with 17 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
docs/src/docPages/api/schema.md
View File

@ -1,14 +1,28 @@
# Schema
## Get the ProseMirror schema without initializing the editor
Tiptap is based on ProseMirror and just like ProseMirror does, tiptap works with an underlying schema. This schema has all the information about nodes, marks and your custom extension. It’s used to convert your content to HTML and vice-versa. Tiptap handles the schema for you, but there are a few use cases where you need the schema, without an actual editor.
## Get the underlying ProseMirror schema
If you just want to have the schema without initializing an actual editor, you can use the `getSchema` function. This function needs an array of available extensions and generates a ProseMirror schema for you:
```js
import { getSchema } from '@tiptap/core'
import Document from '@tiptap/extension-document'
import Paragraph from '@tiptap/extension-paragraph'
import Text from '@tiptap/extension-text'
const schema = getSchema(extensions)
const schema = getSchema([
new Document,
new Paragraph,
new Text,
// add more extensions here
])
```
## Generate HTML from ProseMirror JSON without initializing the editor
You might need this on the server side, if you’re using the collaborative text editing features of tiptap.
## Generate HTML from ProseMirror JSON
<demo name="Api/Schema" />