Skip to content

konstantinmuenster/strapi-plugin-rich-text

Repository files navigation

🛹 Strapi Plugin Rich Text

A WYSIWYG editor for your rich text fields

This Strapi plugin replaces the Markdown editor with a visual, easy-to-use text editor.

  • 🧑‍🎓 Write content without needing to know Markdown syntax.
  • 💅 Edit content visually, as in GoogleDocs or Notion.
  • 🧱 Add rich content elements, such as embedded YouTube videos.
  • 📦 Have your existing Markdown content automatically migrated.

The plugin stores the content in HTML format. When querying content on the frontend, you can simply render the received HTML string.


strapi-rich-text-plugin


Getting Started

Install

pnpm install strapi-plugin-rich-text

# Rebuild your Strapi admin panel
pnpm run build

After this, the Rich Text plugin should show up in your list of Plugins in the admin panel.

Configuration

What How
Allow YouTube Embeds If you want to embed videos from YouTube, make sure you update your strapi::security middleware (see here).

Contributing

This project uses Node.js 18 and pnpm. Make sure to meet these requirements before running

pnpm install

to install the dependencies.

This project includes an exemplary Strapi installation, which you can use to test the plugin while developing. If you clone the repository, you find a pre-populated SQLite database as well as the needed .env inside the project.

You can start the development server via pnpm dev and access the Strapi admin with the following user credentials:

E-Mail Address: [email protected]
Password: dummyAdmin123

The Strapi admin already contains some playgrounds to test the editor.

Unfortunately, the Strapi installation doesn't support hot reloads yet. If you update the plugin code inside packages/strapi-plugin-rich-text, you need to rebuild the Strapi admin in order to see your changes. Feel free to add this!

About

Buy Me A Coffee

Konstantin Münster – konstantin.digital

Distributed under the MIT license. See LICENSE for more information.

https://github.com/konstantinmuenster