Home

Welcome to the WindAndKite Storyblok Integration Module Wiki

Seamlessly integrate Storyblok content with your Magento 2 store.

---

Welcome to the official documentation for the WindAndKite_Storyblok Magento 2 module. This module provides a robust and flexible framework for fetching and rendering dynamic content from your Storyblok spaces directly within your Magento application. Designed with developer control in mind, it empowers theme developers to fully customize the presentation of Storyblok content, ensuring complete compatibility with any Magento 2 theme.

💡 What is Storyblok?

Storyblok is a leading headless Content Management System (CMS) that empowers content creators to build and manage digital experiences across various channels, while providing developers with the flexibility to use their preferred frontend technologies. Its component-based approach and visual editor enable rich content creation and a seamless editing experience.

This WindAndKite_Storyblok module bridges your Magento 2 store with Storyblok, allowing you to leverage Storyblok's powerful content management capabilities for non-e-commerce content, marketing pages, or even richer product descriptions, all rendered directly within your Magento theme.

✨ Key Features

• Effortless Storyblok API Integration: Simply configure your Storyblok Space API key in the Magento admin.
• Intelligent Content Routing: A custom router ensures Storyblok content is only served when no matching Magento URL exists, preventing conflicts and offering ultimate flexibility.
• Full Theme Developer Control: No opinionated rendering! Define your own content templates within your Magento theme to perfectly match your design system. This design choice makes it fully compatible with any Magento 2 theme, including Hyvä Themes.
• Built-in SEO Integration: Integration for the Storyblok SEO App Built Into directly into the module.
• Integrated Sitemap Generation: Automatically includes your Storyblok pages in the Magento XML sitemap for enhanced SEO.
• Flexible Story Lists: Easily display collections of Storyblok content on your Magento storefront with pagination controls.
• Optimized for Performance: Built with performance in mind, ensuring fast and efficient content delivery.
• Developer-Friendly: Clear and concise configuration options, with extensibility points for advanced customization.

🚀 Getting Started

Ready to bring the power of Storyblok to your Magento 2 store? Follow these simple steps to get started:

1. Installation Guide
   • Learn how to install the WindAndKite_Storyblok module into your Magento 2 project.
2. Configuration
   • Understand how to configure your Storyblok API key and other module settings.
3. Content Routing
   • Dive into how the module fetches content and, crucially, how to create your custom content templates within your Magento theme. This is where you bring your Storyblok content to life!

📖 Table of Contents

User Guides

• Quick Start
• Installation Guide
• Upgrading to 3.0
• Configuration Guide
• SEO App Integration

Developer Guides

• Content Routing
• Creating Custom Templates
• Hydrating Blocks
• Generating the Component Schema
• Accessing Storyblok Data
• Working with Visual Editor
• Displaying Story Lists

Support

• Troubleshooting Guide
• Contributing
• License

🤝 Contributing

We welcome contributions to the WindAndKite_Storyblok module! If you've found a bug, have a feature suggestion, or want to improve the documentation, please refer to our- Contributing Guide for details on how to get involved.