rtablada/literate-routes

Allows for literate routes in php

dev-master 2014-02-27 07:05 UTC

This package is not auto-updated.

Last update: 2022-10-01 05:06:18 UTC


README

This package allows you to write Literate routes files for Laravel and build them using an artisan command.

Installation

To install this package require "rtablada/literate-routes": "dev-master". Then add 'Rtablada\LiterateRoutes\LiterateRoutesServiceProvider' to your app/config/app.php file.

Use

To write literate PHP files, you need to need to create files with the extension .php.md or .litphp. Then when you want to compile your literate PHP files, run php artisan literate:build.

Literate PHP Syntax

For the most part, Literate PHP is just markdown files allowing you to write user stories, to do lists, and more.

Then code blocks are parsed into PHP. Currently, Literate PHP only supports a blade-like syntax for defining routes and comments.

Routes

Routes can be defined using the following syntax:

	@get('item', 'ItemsController@index')

And will output:

Route::get('item', 'ItemsController@index');

Comments

Comments can be included by using markdown H1 tags using the following syntax:

# Items

And will output:

// Items