LaRecipe: Documentation with Markdown in Your Laravel Projects

Published on by

LaRecipe: Documentation with Markdown in Your Laravel Projects image

LaRecipe is a code-driven package created by Saleem Hadad that provides an easy way to create beautiful documentation for your product or application inside your Laravel app using Markdown.

To get started in your project, you need to install it via composer and run the setup command to publish the necessary assets and configuration:

php artisan larecipe:install

Out of the box, LaRecipe put’s your documentation at the /docs URL, and you can version control your documentation alongside your application. The folder structure of a typical installation looks like this:

├─ config
│ └─ larecipe.php
└─ resources
└─ docs
│─ 1.0
│ │─ index.md
│ └─ overview.md
└─ 2.0
│─ index.md
└─ overview.md

The above example would have routes to /docs/1.0 and /docs/2.0. You can customize the base route, path to the documentation files, and the landing page. For example, configuring the landing configuration option to overview would map to overview.md.

You can also configure the default version, and control published versions of the documentation:

return [
'versions' => [
'default' => '1.0',
'published' => [
'1.0'
]
]
];

LaRecipe includes other configurations that you can learn about in the documentation and from the PHP configuration file.

LaRecipe converts your markdown documents into HTML, with optional Vue component support. You can read about Vue component support in the documentation. Out of the box, it includes Vue components for Cards, Buttons, Badges, and Progress.

You can get started with LaRecipe by reading through the LaRecipe documentation. The source code is also available at saleem-hadad/larecipe on GitHub.

Paul Redmond photo

Staff writer at Laravel News. Full stack web developer and author.

Cube

Laravel Newsletter

Join 40k+ other developers and never miss out on new tips, tutorials, and more.

image
No Compromises

Joel and Aaron, the two seasoned devs from the No Compromises podcast, are now available to hire for your Laravel project.

Visit No Compromises
Laravel Forge logo

Laravel Forge

Easily create and manage your servers and deploy your Laravel applications in seconds.

Laravel Forge
Tinkerwell logo

Tinkerwell

The must-have code runner for Laravel developers. Tinker with AI, autocompletion and instant feedback on local and production environments.

Tinkerwell
No Compromises logo

No Compromises

Joel and Aaron, the two seasoned devs from the No Compromises podcast, are now available to hire for your Laravel project. ⬧ Flat rate of $7500/mo. ⬧ No lengthy sales process. ⬧ No contracts. ⬧ 100% money back guarantee.

No Compromises
Kirschbaum logo

Kirschbaum

Providing innovation and stability to ensure your web application succeeds.

Kirschbaum
Shift logo

Shift

Running an old Laravel version? Instant, automated Laravel upgrades and code modernization to keep your applications fresh.

Shift
Bacancy logo

Bacancy

Supercharge your project with a seasoned Laravel developer with 4-6 years of experience for just $2500/month. Get 160 hours of dedicated expertise & a risk-free 15-day trial. Schedule a call now!

Bacancy
LoadForge logo

LoadForge

Easy, affordable load testing and stress tests for websites, APIs and databases.

LoadForge
Paragraph logo

Paragraph

Manage your Laravel app as if it was a CMS – edit any text on any page or in any email without touching Blade or language files.

Paragraph
Lucky Media logo

Lucky Media

Bespoke software solutions built for your business. We ♥ Laravel

Lucky Media
Lunar: Laravel E-Commerce logo

Lunar: Laravel E-Commerce

E-Commerce for Laravel. An open-source package that brings the power of modern headless e-commerce functionality to Laravel.

Lunar: Laravel E-Commerce
DocuWriter.ai logo

DocuWriter.ai

Save hours of manually writing Code Documentation, Comments & DocBlocks, Test suites and Refactoring.

DocuWriter.ai
Rector logo

Rector

Your partner for seamless Laravel upgrades, cutting costs, and accelerating innovation for successful companies

Rector

The latest

View all →
Non-backed Enums in Database Queries and a withSchedule() bootstrap method in Laravel 11.1 image

Non-backed Enums in Database Queries and a withSchedule() bootstrap method in Laravel 11.1

Read article
Laravel Pint --bail Flag image

Laravel Pint --bail Flag

Read article
Laravel Herd for Windows is now released! image

Laravel Herd for Windows is now released!

Read article
The Laravel Worldwide Meetup is Today image

The Laravel Worldwide Meetup is Today

Read article
Cache Routes with Cloudflare in Laravel image

Cache Routes with Cloudflare in Laravel

Read article
Learn how to manage timezones in your Laravel Apps image

Learn how to manage timezones in your Laravel Apps

Read article