LaRecipe
A Laravel package for creating beautiful documentation using Markdown directly inside your Laravel application.
What is LaRecipe?
LaRecipe is a Laravel package that allows developers to create and serve beautiful documentation for their products or applications directly inside their Laravel app. It uses Markdown files to generate documentation with a clean, customizable UI, eliminating the need for external documentation tools. The package integrates seamlessly with Laravel projects, providing features like versioning, search, and extensibility through official add-ons.
Laravel developers and teams who need to maintain product or API documentation within their existing Laravel applications, especially those preferring a code-driven, self-hosted solution.
Developers choose LaRecipe for its tight integration with Laravel, ease of setup, and ability to manage documentation as part of their codebase. It offers a customizable, feature-rich alternative to external documentation platforms, with support for themes, versioning, and extensibility through packages.
Overview
✏️ Write gorgeous documentation for your products using Markdown inside your Laravel app
Use Cases
Best For
- Creating product documentation for Laravel-based applications
- Building API documentation with Markdown and Swagger integration
- Self-hosting documentation without relying on third-party services
- Maintaining versioned documentation for different releases
- Adding searchable documentation to Laravel projects
- Customizing documentation themes and layouts (e.g., dark mode, RTL)
Not Ideal For
- Projects not built with Laravel or requiring multi-framework compatibility
- Teams needing real-time collaborative editing or WYSIWYG interfaces for non-technical writers
- Large-scale documentation platforms requiring advanced content management systems (CMS) features
- Applications where documentation must be completely decoupled from the main codebase for independent deployment
Pros & Cons
Pros
Installs via Composer and sets up with a single Artisan command, making it effortless to integrate documentation directly into existing Laravel projects as shown in the simple 'php artisan larecipe:install' step.
Uses Markdown files stored in the project, enabling easy writing and maintenance with built-in UI components like alerts and tabs to enhance readability without external tools.
Supports custom themes including dark mode and RTL layouts, allowing developers to tailor the documentation UI to match branding or user preferences, as evidenced by official theme packages.
Offers official add-ons for features like feedback collection and Swagger integration, making it easy to extend functionality without reinventing the wheel.
Cons
Tightly coupled to Laravel, so it's unsuitable for projects using other frameworks or languages, limiting its applicability despite the mention of a future .NET version.
Lacks advanced features like real-time collaboration or WYSIWYG editors, requiring additional development or reliance on extensions for complex documentation needs.
Deep theme or functionality changes may require knowledge of Vue.js and Laravel, as the UI is built with Vue.js, potentially increasing complexity for non-frontend developers.
Frequently Asked Questions
Related Projects
LiveWireA full-stack framework for Laravel that takes the pain out of building dynamic UIs.
Debug BarDebugbar for Laravel (Integrates PHP Debug Bar)
IDE HelperIDE Helper for Laravel
Intervention ImagePHP Image Processing
Found a gem we're missing?
Open-Awesome is built by the community, for the community. Submit a project, suggest an awesome list, or help improve the catalog on GitHub.