Weave Code
Kurenai Laravel Package
orchestra/kurenai
Orchestra Kurenai is a Laravel package for managing URL redirects in a clean, centralized way. It helps preserve SEO and keep legacy links working by letting you define and handle redirections that integrate smoothly with modern Laravel applications.
Markdown document parser with metadata.
Frequently asked questions about Kurenai
- What is Orchestra Kurenai used for?
- Orchestra Kurenai is a Laravel package for parsing Markdown documents that also carry metadata, so content and its attributes can live in a single file. It follows standard Laravel conventions such as Composer installation, service provider registration and config publishing. Typical use cases are documentation pipelines, blog posts, comments and CMS-like content flows. Version 0.2.0 adds CommonMark support for standards-compliant rendering.
- How do I install orchestra/kurenai in a Laravel app?
- Install it with Composer using composer require orchestra/kurenai, then publish any package configuration if the README requires it. Laravel package auto-discovery should register the service provider, but confirm this in your application's provider list. Because the package is pre-1.0, pin an exact version in composer.json rather than relying on a loose constraint.
- Does Orchestra Kurenai support CommonMark?
- Yes, CommonMark support was introduced in v0.2.0 as an incremental feature rather than a breaking-change release. Before enabling it broadly, verify whether CommonMark is opt-in via a config switch or has become the default renderer. Compare rendered output against your current Markdown behavior on representative content, since CommonMark can change edge cases such as tables, nested lists and raw HTML.
- Which PHP and Laravel versions does orchestra/kurenai support?
- The supported PHP and Laravel version ranges are defined in the package's composer.json, so check that file and the README before upgrading. Constraints can change between pre-1.0 releases, which is one reason to pin exact versions. Run a Composer update in a branch first to surface any dependency conflicts with your application.
- How do I parse Markdown with front matter metadata?
- Kurenai parses a Markdown document together with its metadata block and returns both the content and the associated attributes, so you can store titles, slugs or layout hints alongside the body text. The exact API and method names should be confirmed against the README for your pinned version, since the package is still pre-1.0. Wrap the parser behind a small application service so future API churn stays contained.
- Is v0.2.0 backward compatible with v0.1.x, and is it safe for production?
- The v0.2.0 release appears to be an incremental feature addition rather than a breaking-change signal, but the package remains pre-1.0 and should be treated as early-stage. Review the changelog for migration notes and confirm whether existing configuration keys remain valid. For production, pin the exact version and keep a rollback path to the previous renderer and configuration.
- Does Orchestra Kurenai sanitize HTML by default?
- HTML handling and sanitization are key concerns with any Markdown renderer and should not be assumed. Review the package's documentation and tests to determine whether raw HTML is allowed and whether sanitization is delegated to the host application. If raw HTML is enabled, sanitize output yourself or disable raw HTML for untrusted user content to avoid XSS exposure.
- Can I use custom CommonMark extensions with Kurenai?
- Extension and plugin compatibility depends on which CommonMark implementation the package uses and whether it exposes registration hooks. Check the README and source for an extension registration point before designing around a specific extension. If support is missing, keep custom rendering in your application layer or evaluate league/commonmark directly.
- How should I test a Kurenai upgrade before rolling it out?
- Add golden-file rendering tests that compare output for a representative corpus of your real content, including tables, links, nested lists and any raw HTML. Enable the new renderer behind a feature flag or config switch and stage it before enabling it by default. Also run the package's own test suite and your application's integration tests after the Composer update.
- What alternatives to Orchestra Kurenai should I consider?
- The main alternative is using league/commonmark, or another Markdown library such as Parsedown, directly in your application. Kurenai's value is the Laravel integration plus document metadata handling, so choose it when you want that convenience rather than a bare renderer. If you only need raw CommonMark rendering without metadata, a direct library dependency may give you more control and a smaller surface area.
Weaver
How can I help you explore Laravel packages today?