Skip to content

Commit

Permalink
docs: reformat and update README
Browse files Browse the repository at this point in the history
  • Loading branch information
roelofr committed Apr 19, 2024
1 parent 53a8640 commit b563a28
Showing 1 changed file with 12 additions and 4 deletions.
16 changes: 12 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@
[![Latest Version on Github](https://img.shields.io/github/release/advoor/nova-editor-js.svg?style=flat-square)](https://packagist.org/packages/advoor/nova-editor-js)
[![Total Downloads](https://img.shields.io/packagist/dt/advoor/nova-editor-js.svg?style=flat-square)](https://packagist.org/packages/advoor/nova-editor-js)

A Laravel Nova implementation of [Editor.js](https://github.com/codex-team/editor.js) by [@advoor](https://github.com/advoor).
A Laravel Nova implementation of [Editor.js](https://github.com/codex-team/editor.js)
by [@advoor](https://github.com/advoor).

## Installation

Expand All @@ -25,7 +26,8 @@ Laravel Nova 4.x isn't backwards compatible with 3.x, so we had to make a versio
Please use the below table to find which versions are suitable for your installation.

| Package version | Nova Version | Laravel Version | PHP version |
| --------------- | ------------ | --------------- | ----------- |
|-----------------|--------------|-----------------|-------------|
| `4.x` | 4.x | 10.x - 11.x | 8.2+ |
| `3.x` | 4.x | 8.x - 10.x | 8.1+ |
| `2.x` | 2.x - 3.x | 5.x - 8.x | 5.6 - 7.4 |

Expand Down Expand Up @@ -117,14 +119,19 @@ From the config, you can define the following editor settings:

- `placeholder` ([docs][placeholder-docs]) - The placeholder to show in an empty editor
- `defaultBlock` ([docs][defaultblock-docs]) - The block that's used by default
- `autofocus` ([docs][autofocus-docs]) - If the editor should auto-focus, only use if you never have multiple editors on a page and after considering the
- `autofocus` ([docs][autofocus-docs]) - If the editor should auto-focus, only use if you never have multiple editors on
a page and after considering the
[accessibility implications][autofocus-accessibility]
- `rtl` ([docs][rtl-docs]) - Set to true to enable right-to-left mode, for languages like Arabic and Hebrew

[placeholder-docs]: https://editorjs.io/configuration#placeholder

[defaultblock-docs]: https://editorjs.io/configuration#change-the-default-block

[autofocus-docs]: https://editorjs.io/configuration#autofocus

[autofocus-accessibility]: https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/autofocus#accessibility_considerations

[rtl-docs]: https://editorjs.io/i18n#rtl-support

Furthermore, you can customize the tools the editor should use. The following tools are enabled by default:
Expand All @@ -149,4 +156,5 @@ content. It does not have an entry in the "Add" menu.

### Registering custom components

Please refer to the [extending Nova EditorJS](./EXTENDING.md) guide on instructions on how to register custom components.
Please refer to the [extending Nova EditorJS](./EXTENDING.md) guide on instructions on how to register custom
components.

0 comments on commit b563a28

Please sign in to comment.