Weave Code
Markdown Docs Bundle Laravel Package
mobizel/markdown-docs-bundle
A Symfony bundle that turns plain Markdown files into a browsable documentation site. It handles routing, navigation menus, and Twig rendering, with configurable source paths and templates, so you can write docs in Markdown and let the bundle generate the pages.
Markdown Docs Bundle is a Symfony bundle for serving Markdown-based documentation directly from your application. It turns .md files into browsable documentation pages while handling routing and rendering through Symfony.
- Configure documentation directories
- Render content with CommonMark
- Integrate pages via Symfony routing
- Customize output with Twig templates
- Keep docs versioned alongside your code
Frequently asked questions about Markdown Docs Bundle
- Can I use mobizel/markdown-docs-bundle in a Laravel application?
- Not cleanly. It is a Symfony bundle that ships a Bundle subclass, a DI Extension and Configuration tree, Symfony routing, Twig templates, and symfony/finder-based doc discovery, none of which map onto Laravel's service-provider, Blade, and route model. Installing it in a Laravel app pulls in symfony/http-kernel and twig/twig and risks version conflicts with the Symfony components Laravel already resolves. For Laravel you are better off reimplementing the thin domain logic with league/commonmark, a route, and a Blade layout.
- What Symfony and PHP versions does mobizel/markdown-docs-bundle require?
- The exact constraints are only visible in the package's composer.json, which you should check before any design work. Given the April 2022 release, expect a Symfony 5.x or early 6.0 floor rather than Symfony 6.4 or 7.x support. Run composer why-not mobizel/markdown-docs-bundle against your target framework version in a throwaway branch to see the real conflict set before committing to an approach.
- Is mobizel/markdown-docs-bundle still maintained?
- Treat it as abandoned. The last release was 2022-04-20, the project has roughly 10 stars and no dependents, and there is no visible commit activity or security disclosure process. Bus factor is effectively one agency, so there is no community to inherit bug fixes or edge-case knowledge from. Pin it, fork it, or reimplement the parts you need rather than depending on upstream updates.
- How do I install mobizel/markdown-docs-bundle?
- It is a Symfony bundle, so installation is a Composer require plus bundle registration in config/bundles.php and routing or configuration under config/packages. That workflow assumes a Symfony skeleton with Twig and the Symfony routing stack already wired up. There is no Laravel service provider or facade, so there is no supported install path for a Laravel application.
- Which Markdown parser does mobizel/markdown-docs-bundle use?
- The documentation excerpt does not state the parser, which is the single most important detail to confirm before adopting or porting it. Read composer.json and the renderer service to see whether it wraps league/commonmark, parsedown, or michelf/php-markdown. That answer determines whether you can preserve the original parsing semantics in a Laravel reimplementation or whether you are just rebuilding equivalent behavior with league/commonmark anyway.
- How do I build a Markdown documentation site in Laravel without this bundle?
- Use primitives your team already debugs: league/commonmark to convert Markdown to HTML, a Route::get for docs pages with an optional page parameter, a Finder or Storage scan to build the navigation tree, a Blade layout with a nav partial, and a response cache. The whole thing lands at roughly 300 to 500 lines of code. That is far less effort than extracting a Symfony bundle and avoids the Twig rewrite entirely.
- Does mobizel/markdown-docs-bundle support front matter and custom navigation order?
- Unclear from the available documentation, and you should verify it in the source before relying on it. If navigation is purely filesystem-derived, the order comes from directory listings and you have limited control. If it is configuration-driven or front-matter-aware, the bundle's conventions may be worth reproducing in your own implementation even if you do not adopt the package.
- Is it safe to render Markdown with mobizel/markdown-docs-bundle?
- Markdown renderers commonly allow raw HTML, which makes stored XSS a real risk for public-facing docs, and route parameters mapped to filenames open a path traversal vector via ../ sequences. Finder scans over symlinked doc trees can also loop. There are no advisories and no maintainer SLA, so you own the threat model: sanitize HTML output and validate slugs against a whitelist if you expose this to untrusted content.
- Does mobizel/markdown-docs-bundle work with Symfony 7 or Laravel 11?
- Almost certainly not without work. The bundle predates both and its Symfony constraints were fixed in 2022, so dependency resolution is the first blocker rather than code incompatibility. Laravel 11 is a harder no because the bundle depends on Symfony kernel, routing, and Twig conventions that do not exist in Laravel's architecture. Confirm with Composer before writing integration code.
- What are the alternatives to mobizel/markdown-docs-bundle for Laravel projects?
- The recommended path is reimplementing the pattern natively with league/commonmark, a docs controller, a Blade nav partial, and a response cache. Forking and porting the bundle to a Laravel service provider is viable if its navigation semantics turn out to be rich, but costs two to four weeks. Running it as a sidecar Symfony app behind a route is overkill for static documentation, and installing it directly alongside Laravel is not viable.
Weaver
How can I help you explore Laravel packages today?