- How do I install the laravel-markdown package in a Laravel application?
- Install it with Composer using composer require jeffersongoncalves/laravel-markdown. Laravel package auto-discovery registers the service provider, so no manual provider entry is usually needed. You can then publish the package config if you need to customize rendering options. Check the repository README for the exact facade or helper API used to render Markdown to HTML.
- Does laravel-markdown support CommonMark and GitHub-flavored Markdown?
- Yes. The package renders CommonMark plus GitHub-flavored Markdown extensions and adds server-side syntax highlighting and heading permalinks. That makes it suitable for documentation, blog posts, CMS pages, and similar content. Rendering happens server-side, so the resulting HTML can be cached or returned in API responses.
- Which Laravel and PHP versions are supported by laravel-markdown?
- The package is a Composer-installed Laravel integration, but the provided context does not list exact Laravel and PHP version constraints. Check the composer.json file in the GitHub repository or on Packagist before adopting it. Confirm compatibility with your application's Laravel version, PHP version, and any existing league/commonmark constraint.
- How do I configure heading permalink IDs and id_prefix?
- Publish or diff the package configuration and set the heading permalink id_prefix explicitly instead of relying on the default. In v2.1.0 the default id_prefix is an empty string, which can change generated heading anchor IDs. Defining id_prefix up front keeps deep links, tables of contents, and cached HTML stable across upgrades.
- Why did my documentation TOC or heading anchor links break after upgrading to v2.1.0?
- The v2.1.0 release changes the default heading permalink id_prefix to an empty string, which can alter generated heading IDs. Any TOC links, deep links, search indexes, or cached rendered HTML that depended on the old prefix may no longer match. Set id_prefix explicitly to preserve legacy anchors, re-render affected content, and clear application, view, and response caches after deployment.
- Is it safe to render user-generated Markdown with this package?
- The package is best suited to trusted or sanitized Markdown rendered server-side. The provided evaluation does not describe built-in HTML sanitization, so sanitize untrusted input before rendering. Treat raw HTML in Markdown as a security concern and apply your application's normal content sanitization policy.
- Does laravel-markdown include server-side syntax highlighting?
- Yes. The package advertises server-side syntax highlighting along with CommonMark and GitHub-flavored Markdown rendering. Because highlighting happens server-side, you do not need a client-side JavaScript highlighter for basic code block rendering. You should still verify theme and language coverage for your content.
- How should I cache rendered Markdown in a high-traffic Laravel app?
- Markdown rendering is stateless and CPU-bound, so cache the resulting HTML aggressively for high-traffic pages such as documentation and CMS content. Avoid re-rendering identical Markdown on every request. When configuration such as id_prefix changes, invalidate the cache and re-render content so anchor IDs stay consistent.
- How can I test heading permalink changes before deploying an upgrade?
- Pin staging to the previous version, capture baseline HTML output, then upgrade staging with an explicit id_prefix configuration. Diff rendered HTML, TOC output, and anchor links, and run content or SEO link checks. After deployment, clear caches and monitor for anchor-related 404s and navigation regressions.
- Is laravel-markdown actively maintained, and what are the alternatives?
- The package appears to be maintained by a single individual, with community support through GitHub issues and no SLA. Budget for periodic dependency review and keep a fork or fallback plan. As an alternative, you can use league/commonmark directly or another Laravel Markdown wrapper if you need a different support model.