ianhitchman/tiptap
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

update readme

Browse Source
This commit is contained in:
Philipp Kühn
2018-08-24 09:35:59 +02:00
committed by GitHub
parent 053cb49424
commit bfef7f985a
1 changed files with 12 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@@ -41,7 +41,7 @@ export default {
## Editor Properties ## Editor Properties
| Property | Type | Default | Description | | **Property** | **Type** | **Default** | **Description** |
| - | :-: | :-: | - | | - | :-: | :-: | - |
| editable | Boolean | `true` | When set to `false` the editor is read-only. | | editable | Boolean | `true` | When set to `false` the editor is read-only. |
| doc | Object | `null` | The editor state object used by Prosemirror. You can also pass HTML to the `content` slot. When used both, the `content` slot will be ignored. | | doc | Object | `null` | The editor state object used by Prosemirror. You can also pass HTML to the `content` slot. When used both, the `content` slot will be ignored. |
@@ -52,7 +52,7 @@ export default {
By default the editor will only support some boring paragraphs. Other nodes and marks are available as **extensions**. There is a package called `tiptap-extensions` with the most basic nodes, marks and plugins. By default the editor will only support some boring paragraphs. Other nodes and marks are available as **extensions**. There is a package called `tiptap-extensions` with the most basic nodes, marks and plugins.
#### Available Extensions ### Available Extensions
```vue ```vue
<template> <template>
@@ -109,10 +109,17 @@ export default {
</script> </script>
``` ```
#### Create Custom Extensions ### Create Custom Extensions
Soon … The most powerful feature of tiptap is that you can create you own extensions. There are 3 basic types of extensions.
Until then you can take a look at the [embed example](https://github.com/heyscrumpy/tiptap/tree/master/examples/Components/Routes/Embeds).
| **Type** | **Description** |
| - | - |
| Extension | The most basic type. It's useful to register some [Prosemirror plugins](https://prosemirror.net/docs/guide/) or some input rules. |
| Node | Add a custom node. Nodes are basically block elements like a headline or a paragraph. |
| Mark | Add a custom mark. Marks are used to add extra styling or other information to inline content like a strong tag or links. |
For a live example you can take a look at the [embed example](https://github.com/heyscrumpy/tiptap/tree/master/examples/Components/Routes/Embeds).
## Contributing ## Contributing