/storyblok-rich-text-renderer

Fast renderer for your rich-text content.

Primary LanguageTypeScript

Storyblok Rich-Text Renderer ⚡

Build Status Release

The easy and fast renderer for your Storyblok rich-text content! 💪

Status ⚠️

Currently in an early state but it's intended to make it production ready.

Why does this exist ❓

Storyblok has it's own rich-text renderer but for that you need the Vue.js runtime compiler (which increases your bundle size) and the configuration is a bit difficult. That's why I've created this renderer to simply render your content without all the configuration stuff and without the Vue.js runtime compiler. You can still configure every available node by overriding it with your custom component and also supports your custom Storyblok components. 😊

Hold your beer 🍺:

With the separate types package you know exactly which node has which attributes available. 😲

Packages 📦

@marvr/storyblok-rich-text-types:

Type definitions for every node

@marvr/storyblok-rich-text-vue-renderer:

Vue.js plugin for rendering the rich-text content

Features ✨

  • No runtime compiler
  • Easy configurable
  • Shipped with defaults
  • Supports custom Storyblok components
  • Fast by default
  • Written in TypeScript

Documentation 📔

The full documentation can be found here.