diff --git a/docs/src/demos/Guide/StoreContent/ExportHTML/index.spec.js b/docs/src/demos/Guide/StoreContent/ExportHTML/index.spec.js new file mode 100644 index 00000000..09bd9fb2 --- /dev/null +++ b/docs/src/demos/Guide/StoreContent/ExportHTML/index.spec.js @@ -0,0 +1,19 @@ +context('/guide/store-content', () => { + before(() => { + cy.visit('/guide/store-content') + }) + + beforeEach(() => { + cy.get('.ProseMirror').then(([{ editor }]) => { + editor.commands.setContent('

Example Text

') + }) + }) + + it('should return html', () => { + cy.get('.ProseMirror').then(([{ editor }]) => { + const html = editor.getHTML() + + expect(html).to.equal('

Example Text

') + }) + }) +}) diff --git a/docs/src/demos/Guide/StoreContent/ExportHTML/index.vue b/docs/src/demos/Guide/StoreContent/ExportHTML/index.vue new file mode 100644 index 00000000..0509ac3b --- /dev/null +++ b/docs/src/demos/Guide/StoreContent/ExportHTML/index.vue @@ -0,0 +1,157 @@ + + + + + diff --git a/docs/src/demos/Guide/StoreContent/index.spec.js b/docs/src/demos/Guide/StoreContent/ExportJSON/index.spec.js similarity index 78% rename from docs/src/demos/Guide/StoreContent/index.spec.js rename to docs/src/demos/Guide/StoreContent/ExportJSON/index.spec.js index 188020e7..e4cb490a 100644 --- a/docs/src/demos/Guide/StoreContent/index.spec.js +++ b/docs/src/demos/Guide/StoreContent/ExportJSON/index.spec.js @@ -29,12 +29,4 @@ context('/guide/store-content', () => { }) }) }) - - it('should return html', () => { - cy.get('.ProseMirror').then(([{ editor }]) => { - const html = editor.getHTML() - - expect(html).to.equal('

Example Text

') - }) - }) }) diff --git a/docs/src/demos/Guide/StoreContent/index.vue b/docs/src/demos/Guide/StoreContent/ExportJSON/index.vue similarity index 80% rename from docs/src/demos/Guide/StoreContent/index.vue rename to docs/src/demos/Guide/StoreContent/ExportJSON/index.vue index cc17b2d2..63ccecb5 100644 --- a/docs/src/demos/Guide/StoreContent/index.vue +++ b/docs/src/demos/Guide/StoreContent/ExportJSON/index.vue @@ -18,8 +18,6 @@
-

HTML

-
{{ html }}

JSON

@@ -38,7 +36,6 @@ export default { return { editor: null, json: null, - html: null, } }, @@ -46,10 +43,7 @@ export default { this.editor = new Editor({ content: `

- What would be a text editor without content. At some point you want to get the content out of the editor and yes, we got you covered. There are two methods to export the current document as HTML or JSON. -

-

- You can hook into the update event to get the content after every single change. How cool is that? + Wow, this editor instance exports its content as JSON.

`, extensions: defaultExtensions(), @@ -57,18 +51,16 @@ export default { // Get the initial content … this.json = this.editor.getJSON() - this.html = this.editor.getHTML() // … and get the content after every change. this.editor.on('update', () => { this.json = this.editor.getJSON() - this.html = this.editor.getHTML() }) }, methods: { setContent() { - // You can pass a JSON document … + // You can pass a JSON document to the editor. this.editor.commands.setContent({ type: 'document', content: [{ @@ -82,9 +74,6 @@ export default { }], }, true) - // … but HTML strings are also supported. - // this.editor.setContent('

This is some inserted text. 👋

') - // It’s likely that you’d like to focus the Editor after most commands. this.editor.commands.focus() }, diff --git a/docs/src/demos/Examples/ReadOnly/index.spec.js b/docs/src/demos/Guide/StoreContent/ReadOnly/index.spec.js similarity index 87% rename from docs/src/demos/Examples/ReadOnly/index.spec.js rename to docs/src/demos/Guide/StoreContent/ReadOnly/index.spec.js index 2b1e4789..4b2d4b36 100644 --- a/docs/src/demos/Examples/ReadOnly/index.spec.js +++ b/docs/src/demos/Guide/StoreContent/ReadOnly/index.spec.js @@ -1,6 +1,6 @@ -context('/examples/read-only', () => { +context('/guide/store-content', () => { beforeEach(() => { - cy.visit('/examples/read-only') + cy.visit('/guide/store-content') }) it.skip('should be read-only', () => { diff --git a/docs/src/demos/Examples/ReadOnly/index.vue b/docs/src/demos/Guide/StoreContent/ReadOnly/index.vue similarity index 100% rename from docs/src/demos/Examples/ReadOnly/index.vue rename to docs/src/demos/Guide/StoreContent/ReadOnly/index.vue diff --git a/docs/src/docPages/guide/store-content.md b/docs/src/docPages/guide/store-content.md index 161b3017..c7a615bf 100644 --- a/docs/src/docPages/guide/store-content.md +++ b/docs/src/docPages/guide/store-content.md @@ -5,10 +5,9 @@ ## Introduction You can store your content as a JSON object or as a good old HTML string. Both work fine. And of course, you can pass both formats to the editor to restore your content. Here is an interactive example, that exports the content as HTML and JSON when the document is changed: -## Example - +## Export -## Option 1: JSON +### Option 1: JSON JSON is probably easier to loop through, for example to look for a mention and it’s more like what tiptap uses under the hood. Anyway, if you want to use JSON to store the content we provide a method to retrieve the content as JSON: ```js @@ -19,19 +18,10 @@ You can store that in your database (or send it to an API) and restore the docum ```js new Editor({ - // … content: { "type": "document", "content": [ - { - "type": "paragraph", - "content": [ - { - "type": "text", - "text": "Example Text" - } - ] - } + // … ] }, }) @@ -43,20 +33,16 @@ Or if you need to wait for something, you can do it later through the editor ins editor.setContent({ "type": "document", "content": [ - { - "type": "paragraph", - "content": [ - { - "type": "text", - "text": "Example Text" - } - ] - } + // … ] }) ``` -## Option 2: HTML +Here is an interactive example where you can see that in action: + + + +### Option 2: HTML HTML can be easily rendered in other places, for example in emails and it’s wildly used, so it’s probably easier to switch the editor at some point. Anyway, every editor instance provides a method to get HTML from the current document: ```js @@ -67,7 +53,6 @@ This can then be used to restore the document initially: ```js new Editor({ - // … content: `

Example Text

`, }) ``` @@ -77,7 +62,11 @@ Or if you want to restore the content later (e. g. after an API call has finishe editor.commands.setContent(`

Example Text

`) ``` -## Not an option: Markdown +Use this interactive example to fiddle around: + + + +### Not an option: Markdown Unfortunately, **tiptap doesn’t support Markdown as an input or output format**. We considered to add support for it, but those are the reasons why we decided to not do it: @@ -91,10 +80,18 @@ If you still think you need Markdown, ProseMirror has an [example on how to deal That said, tiptap does support [Markdown shortcuts](/examples/markdown-shortcuts) to format your content. -## Generate HTML from ProseMirror JSON -If you need to render the content on the server side, for example to generate the HTML for a blog post which has been written in tiptap, you’ll probably want a way to do just that without an actual editor instance. +## Rendering -That’s what the `generateHTML()` is for. It’s a utility function that renders HTML without an actual editor instance. As an alternative, you can also use tiptap in a [read-only mode](/examples/read-only). +### Option 1: Read-only instance of tiptap + +To render the saved content, set the editor to read-only. That’s how you can achieve the exact same rendering as it’s in the editor, without duplicating your CSS and other code. + + + +### Option 2: Generate HTML from ProseMirror JSON +If you need to render the content on the server side, for example to generate the HTML for a blog post which has been written in tiptap, you’ll probably want to do just that without an actual editor instance. + +That’s what the `generateHTML()` is for. It’s a helper function which renders HTML without an actual editor instance. :::info Browser-only rendering Import a lightweight implementation of `generateHTML()` from `@tiptap/core` if you’re using the function in a browser context only. diff --git a/docs/src/links.yaml b/docs/src/links.yaml index aad150cc..98ea9ff4 100644 --- a/docs/src/links.yaml +++ b/docs/src/links.yaml @@ -22,8 +22,9 @@ pro: true - title: Markdown shortcuts link: /examples/markdown-shortcuts - # - title: Formatting - # link: /examples/formatting + - title: Formatting + link: /examples/formatting + draft: true - title: Todo app link: /examples/todo-app - title: Write a book