- How do I install LaRecipe in a Laravel project?
- Run `composer require binarytorch/larecipe` and execute `php artisan larecipe:install`. The package auto-configures a `/docs` endpoint and sets up a `resources/docs/` directory for your Markdown files. No database or complex setup is required for basic usage.
- Does LaRecipe work with Laravel 8 or older versions?
- No, LaRecipe officially supports Laravel 9–13. If you’re using Laravel 8 or below, you’ll need to manually patch compatibility issues, as the package relies on modern Laravel features like route model binding and service container enhancements.
- Can I customize the `/docs` route or use a different URL?
- Yes, LaRecipe allows full route customization. Modify the `routes/web.php` or `routes/api.php` file to change the endpoint (e.g., `/help`, `/guides`). Conflicts with existing routes can be resolved using Laravel’s middleware or route constraints.
- How does LaRecipe handle authentication for documentation?
- LaRecipe integrates with Laravel’s built-in guards (e.g., `web`, `api`) and supports middleware. You can restrict access to authenticated users or specific roles by applying middleware to the `/docs` route, just like any other Laravel route.
- Does LaRecipe support Markdown extensions like Mermaid diagrams or tables?
- LaRecipe uses Parsedown by default, which supports GitHub-flavored Markdown (GFM) basics. For advanced features like Mermaid diagrams, you’ll need to extend the Markdown parser or use a custom plugin. Check the [official extensions](https://larecipe.saleem.dev/) for community-supported add-ons.
- Can I use LaRecipe for public-facing API documentation?
- Yes, LaRecipe includes Swagger/OpenAPI integration via the [LaRecipe Swagger package](https://larecipe.saleem.dev/packages/binarytorch/larecipe-swagger), which auto-generates API docs from your Laravel routes and controllers. For SEO, pair it with Laravel’s meta tag packages or pre-render docs statically during deployment.
- How do I migrate existing documentation (e.g., Confluence, Notion) to LaRecipe?
- Manual migration is required, but tools like Pandoc or custom scripts can automate conversion to Markdown. Expect formatting inconsistencies, so review and refine the output. Store migrated files in `resources/docs/` and organize them hierarchically for clarity.
- Will LaRecipe work with Laravel Forge or custom server setups?
- LaRecipe integrates with Laravel Mix/Vite for theming and assets, so custom environments (e.g., Forge, Sail) may need adjustments. Ensure your asset pipeline is configured correctly, and test the `/docs` endpoint in your staging environment before deploying.
- How can I optimize LaRecipe for high-traffic documentation?
- Use Laravel’s caching system to store rendered Markdown (e.g., `Cache::remember`). For static sites, pre-render docs during CI/CD and serve them via a CDN. Avoid real-time rendering for large doc bases by storing Markdown in a database table for querying.
- Are there alternatives to LaRecipe for Laravel documentation?
- Alternatives include Laravel’s built-in Blade templates for static docs, packages like `spatie/laravel-markdown`, or static site generators (e.g., Hugo, Docusaurus) paired with Laravel. LaRecipe stands out for its native Laravel integration, Swagger support, and theming flexibility without requiring a separate build step.