🍪 Write gorgeous documentation for your products using Markdown inside your Laravel app.

Overview

LaRecipe

Write gorgeous documentations for your products using Markdown inside your Laravel app.

License Release License



LaRecipe 🍪

LaRecipe is simply a code-driven package provides an easy way to create beautiful documentation for your product or application inside your Laravel app.

LaRecipe Screenshot

Official tools and assets support

Title v1.x v2.x
LaRecipe Dark Theme ❌ ✅
LaRecipe RTL Support ❌ ✅
LaRecipe Feedback ❌ ✅
LaRecipe Swagger ❌ ✅

Getting Started

☝️ Install the package via composer.

composer require binarytorch/larecipe

✌️ Run the install command.

php artisan larecipe:install

Visit your app domain with /docs endpoint. That's it.

See full documentation

Examples

  • Zino - 🤖 Custom Arduino library made for humans.
  • Blogged - Blogged is a package provides an easy way to create beautiful blog inside your Laravel projects.
  • Wave - Wave is the perfect starter kit for building your next great idea
  • Nova ADC - Nova is a cloud-based (or on-premise) SaaS application delivery controller.
  • WooSignal - Fastest WooCommerce App Templates.
  • AddChat - All-in-one multi-purpose Chat Widget For Laravel & Codeigniter websites.
  • RoadLeagues - A cycling league management system with an API to allow data distrubution externally.
  • Raileo - Raileo helps you to monitor your website's uptime, performance and SEO
  • Put your docs here 😍 👌

Gold Sponsors

Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]

Nova ADC

Bronze Sponsors

Backers

Thank you to all our backers! 🙏 [Become a backer]

Contributors

This project exists thanks to all the people who contribute. [Contribute].

License

This library is licensed under the MIT License - see the LICENSE.md file for details.

Issues
  • Disable interpolation

    Disable interpolation

    Disable interpolation to allow {{ }} syntax in markdown. This PR will fix #28

    opened by phannaly 27
  • Adding a Custom Component

    Adding a Custom Component

    Describe the bug This is not actually a bug but neither is it a feature request. I'm trying to add my own component and then rebuild the package. However, as soon as a yarn run dev or yarn run production i get 404s for some of the assets

    myurl.local/vendor/binarytorch/larecipe/assets/css/dark.css myurl.local/vendor/binarytorch/larecipe/assets/css/light.css

    Do you have any documentation for how to add custom components and re-build the package (my components will be commited to my fork)

    To Reproduce Add a component TestComponent.vue with just hello world in template name: test-component

    <template>
        <div>
            Hello World
        </div>
    </template>
    
    <script>
        export default {
            name : "test-component"
        }
    </script>
    

    Add new component to globalComponents.js

    ...
    import TestComponent from "../components/TestComponent"
    ...
    Vue.component(TestComponent.name, TestComponent);
    

    Add <test-component></test-component> to overview.md yarn run production or yarn run dev

    Perhaps there is a way of doing this in the vendor directory, but i'm not sure how.

    Expected behavior I would see Hello World in the overview section of the docs but I don't also, the 404s as mentioned above. What am i missing here ?

    bug 
    opened by TheFrankman 18
  • Anchor links not working as expected

    Anchor links not working as expected

    Describe the bug

    - [Example](#example-link)
    
    <a name="example-link">
    ## Example
    

    is directing to base_url/#example-link rather then base_url/segment1/segment2#example-link when the page url is base_url/segment1/segment2

    To Reproduce Current URI = http://localhost:8000/docs/1.0/overview

    # Overview
    
    ---
    
    - [Introduction](#introduction)
    - [Test](#test)
    
    <br>
    <br>
    <br>
    <br>
    <br>
    <br>
    <br>
    <br>
    <br>
    <br>
    <br>
    <br>
    <br>
    <br>
    <br>
    <br>
    <br>
    <br>
    <br>
    <br>
    <br>
    <br>
    <br>
    <br>
    <br>
    <br>
    <br>
    <br>
    <a name="introduction"></a>
    
    ##  Introduction
    

    on anchor click the uri changes to http://localhost:8000/#introduction

    Expected behavior The uri should become http://localhost:8000/docs/1.0/overview#introduction

    Additional context To Achieve the expected result i have to do: - [Introduction](/{{route}}/{{version}}/overview/#introduction) which doesn't seem right to do.

    "laravel/framework": "^6.0", "binarytorch/larecipe": "^2.2",

    opened by jampack 15
  • Does this package support multiple languages? (in development)

    Does this package support multiple languages? (in development)

    Is your feature request related to a problem? Please describe. A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] It's more a question then a feature request, but I had to choose and I'm definitely not reporting a bug.

    Describe the solution you'd like A clear and concise description of what you want to happen. I was wondering if it's possible to supply docs in multiple languages.

    Additional context Add any other context or screenshots about the feature request here. I use this package for localization. https://github.com/mcamara/laravel-localization And this works with the following syntax __('String to translate')

    But I'm not sure if this will work in the .md files.

    enhancement 
    opened by aFluxx 14
  • Allow using a custom guard for authorization by setting config

    Allow using a custom guard for authorization by setting config

    I have come across your lovely package, but my project uses several custom guards which means that $this->authorize('viewLarecipe', $documentation) will always fail, as the web gaurd's $user will always be null.

    This is a pretty straightforward PR that is non-breaking, but allows people to use custom guards to protect their LaRecipe Docs.

    opened by kfriars 13
  • Allow Laravel 6.0

    Allow Laravel 6.0

    opened by matthewnessworthy 13
  • Trying to access array offset on value of type null

    Trying to access array offset on value of type null

    larecipe versions : * v2.2.1 php: php7.4

    laravel : 5.8 This stopped working on php 7.4

    image

    opened by hedeqiang 11
  • Laravel 6.0 support

    Laravel 6.0 support

    Hello team, Laravel 6.0 has just been released :)

    opened by affektde 10
  • GitHub Icon Link

    GitHub Icon Link

    My question is if it's possible to change the GitHub link in the icon next to the version docs. I can't see the option in config file.

    opened by rogermlml 9
Releases(v2.4.4)
Owner
Saleem Hadad
An entrepreneur, mechatronics, and software engineer.
Saleem Hadad
⚙️ A Laravel package to decompose your installed packages, their dependencies, your app & server environment

Introduction Laravel Decomposer decomposes and lists all the installed packages and their dependencies along with the Laravel & the Server environment

LUBUS 501 Oct 12, 2021
InfyOm Laravel Generator - API, Scaffold, Tests, CRUD Laravel Generator

InfyOm Laravel Generator Generate Admin Panels CRUDs and APIs in Minutes with tons of other features and customizations with 3 different themes. Read

InfyOmLabs (InfyOm Technologies) 3.3k Oct 13, 2021
⛔️ Laravel Tinx is archived and no longer maintained.

⛔️ Laravel Tinx (Deprecated) Laravel Tinx was archived on 12th December 2019 and is no longer maintained. Looking for a reloadable version of Laravel

James Furey 432 Oct 15, 2021
Laravel API Documentation Generator

Laravel API Documentation Generator Automatically generate your API documentation from your existing Laravel/Lumen/Dingo routes. php artisan apidoc:ge

Marcel Pociot 3.1k Oct 15, 2021
[Package] Lumen Testing Helper for Packages Development

anik/testbench-lumen is a package, highly inspired by the orchestral/testbench. orchestral/testbench that is a tool for testing Laravel packages.

Syed Sirajul Islam Anik 5 May 9, 2021
This package extends the core file generators that are included with Laravel 5

Extended Migration Generators for Laravel 6, 7 and 8 Easily define the migration schema right in your make:migration command. The new commands this pa

Laracasts 2.4k Oct 18, 2021
A PHP-based sandboxing library with a full suite of configuration and validation options.

A full-scale PHP 5.4+ sandbox class that utilizes PHP-Parser to prevent sandboxed code from running unsafe code. It also utilizes FunctionParser to di

Corveda 165 Oct 15, 2021
A cli tool for creating Laravel packages

Laravel Packager This package provides you with a simple tool to set up a new package and it will let you focus on the development of the package inst

JeroenG 1.1k Oct 18, 2021
Prequel for Laravel. Clear and concise database management.

TL;DR? Test Prequel here! What is Prequel exactly? Prequel is meant to be a database management tool for Laravel to replace the need for separate stan

Protoqol 1.3k Oct 17, 2021
ICEcoder is a browser based code editor, which provides a modern approach to building websites

ICEcoder Code editor awesomeness ...in your browser ICEcoder is a browser based code editor, which provides a modern approach to building websites. By

ICEcoder 1.3k Oct 5, 2021
A code generator for EasySwoole

wise-generator-easyswoole 基于EasySwoole的code-generation改写,主要应用与内部系统。基本上所有类都有所调整,同时也完善了一些功能。 版本说明 版本说明 code-generation 使用命令行,一键生成业务通用代码,支持代码如下: 一键生成项目初始

Ryan 3 Jun 8, 2021
Module Generator Composer Package For Laravel

Module Generator Installation You can install the package via composer: composer require teacoders/module-generator Run the command below to publish t

Tea Coders 20 Sep 6, 2021
Creates an 'artisan workflow:make' command to scaffold out a number of useful GitHub actions workflows for Laravel

Laravel workflow generator This creates a make:workflow artisan command to scaffold out a number of useful GitHub actions workflows for Laravel. Insta

Len Woodward 9 Jul 18, 2021
:rocket: A Smart CRUD Generator For Laravel

Features Generate your models, views, controllers, routes and migrations just in a few clicks. Models visualization through a graph presentation (New

Houssain Amrani 860 Oct 21, 2021
Generate migrations from existing database structures

Laravel Migration Generator Generate migrations from existing database structures, an alternative to the schema dump provided by Laravel. A primary us

Bennett Treptow 240 Oct 22, 2021
A MySQL Workbench plugin which exports a Model to Laravel 5 Migrations

MySQL Workbench Export Laravel 5 Migrations Plugin A MySQL Workbench plugin that allows for exporting a model to Laravel 5 migrations that follow PSR-

Brandon Eckenrode 889 Oct 16, 2021
Open Swoole IDE Helper

Open Swoole IDE Helper This repo works with Open Swoole since release version v4.7.1. This package contains IDE help files for OpenSwoole. You may use

Open Swoole 1 Oct 17, 2021
A handful of tools for PHP developers.

Belt A handful of tools for PHP developers. Version 2.0.0 is out now. Clear documentation, improved tests and code quality. Installation In case you w

Ilya 738 Sep 4, 2021
A PHP webpage that uses string replacements to generate a binary on the fly that you can enter at setup in NEOS.

openpilot-installer-generator A PHP webpage that uses string replacements to generate a binary on the fly that you can enter at setup in NEOS. What is

null 14 Sep 25, 2021