Skip to content

Commit

Permalink
Update volto-slate configuration to indicate it is now part of the co…
Browse files Browse the repository at this point in the history
…re. (#5886)
  • Loading branch information
MostafaMagdyy authored Mar 17, 2024
1 parent e1418f6 commit 43a9c52
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 4 deletions.
18 changes: 14 additions & 4 deletions docs/source/configuration/volto-slate/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ myst:

# `volto-slate`

`volto-slate` is an interactive default text editor for Volto, developed on top of {term}`Slate`.
`volto-slate` is an interactive default text editor for Volto, developed on top of {term}`Slate` and integrated into the core system.
It offers enhanced WYSIWYG functionality and behavior.
See a [brief elevator pitch for `volto-slate`](https://www.youtube.com/watch?v=SOz-rk5e4_w).

Expand All @@ -23,8 +23,18 @@ Some examples of the kind of strong integration we have in mind:
- The text block accepts drag-and-drop images, and it will upload them as Volto image blocks.
- `volto-slate` has a {guilabel}`Table` button with the familiar {guilabel}`size` input, but it creates a table block.

Although this add-on is in an early alpha stage, we have solved most of the big issues.
The API has stabilized, and we have already started several add-ons based on it, including [`volto-slate-metadata-mentions`](https://github.com/eea/volto-slate-metadata-mentions/) and [`volto-slate-zotero`](https://github.com/eea/volto-slate-zotero).
The `volto-slate` API has stabilized, and we have already started several add-ons based on it, including [`volto-slate-metadata-mentions`](https://github.com/eea/volto-slate-metadata-mentions/) and [`volto-slate-zotero`](https://github.com/eea/volto-slate-zotero).

```{versionadded} 16.0.0-alpha.15
`volto-slate` added to Volto core as the default text block.
```

```{deprecated} 16.0.0-alpha.15
`text` text block based on `draftJS` is now deprecated and will be removed from core in Volto 18.
```

To migrate existing projects to `volto-slate`, check the [Upgrade Guide](https://6.docs.plone.org/volto/upgrade-guide/index.html#volto-slate-is-now-in-core) documentation.



(volto-slate-why-another-wysiywg-editor-label)=
Expand Down Expand Up @@ -53,4 +63,4 @@ Some of the main reasons that drove us to create `volto-slate`, instead of enhan
api
configuration-settings
writing-plugins
```
```
1 change: 1 addition & 0 deletions packages/volto/news/5342.documentation
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Update `volto-slate` configuration documentation to indicate it is now part of Volto core. @MostafaMagdyy

0 comments on commit 43a9c52

Please sign in to comment.