Important

📦 Package Migration Notice

This package has been migrated to the Storyblok monorepo.

⚠️ This repository has been archived and is no longer maintained. Development has moved to the monorepo.

New Location: You can now find this package at packages/richtext

Please visit the monorepo for the latest updates, issues, and contributions.

@storyblok/richtext

Official utility designed to convert rich text content—stored in JSON format within Storyblok's CMS—into HTML or framework-specific renderable elements

Features

• Framework-Agnostic Rendering: Outputs raw HTML by default but can be configured to produce framework-specific elements, such as React components or Vue nodes.
• Custom Resolvers: Allows developers to override default rendering behavior for specific elements like links, images, and embedded components. This enables integration with custom components or styling frameworks like Tailwind CSS. Storyblok
• Image Optimization: Supports image optimization options, including lazy loading, responsive sizing, and format conversion (e.g., to WebP), enhancing performance and user experience. Storyblok
• TypeScript Support: Provides full TypeScript typings with generics, ensuring type safety and improved developer experience across different frameworks.

Documentation

For complete documentation, please visit package reference

Contributing

If you'd like to contribute, please refer to the contributing guidelines.

Community

For help, discussion about best practices, or any other conversation that would benefit from being searchable:

• Discuss Storyblok on Github Discussions

For community support, chatting with other users, please visit:

• Discuss Storyblok on Discord

Support

For bugs or feature requests, please submit an issue.

Important

Please search existing issues before submitting a new one. Issues without a minimal reproducible example will be closed. Why reproductions are Required.

I can't share my company project code

We understand that you might not be able to share your company's project code. Please provide a minimal reproducible example that demonstrates the issue by using tools like Stackblitz or a link to a Github Repo lease make sure you include a README file with the instructions to build and run the project, important not to include any access token, password or personal information of any kind.

Feedback

If you have a question, please ask in the Discuss Storyblok on Discord channel.

License

License