@storyblok/astro

The Astro SDK to interact with Storyblok API and enable the Real-time Visual Editing Experience.

Features

• Fetch content from the Content Delivery API
• Connect frontend components with the Visual Editor via StoryblokBridge
• Render rich text content with the Storyblok Rich Text Renderer based on @storyblok/richtext
• StoryblokComponent for dynamic component rendering
• Visual Editor integration using storyblokEditable
• Real-time preview capability using getLiveStory
• Built-in TypeScript support with comprehensive type definitions
• SSR/SSG compatibility for Astro applications

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