Skip to content

Latest commit

 

History

History
executable file
·
25 lines (13 loc) · 848 Bytes

README.md

File metadata and controls

executable file
·
25 lines (13 loc) · 848 Bytes

Laravel 5 Markdown Docs Reader

A Laravel 5 based Markdown Documentation Reader inspired by Dayle Rees' Docs Reader.

Installation

  1. Download or clone this repo.

  2. Run composer install from your projects root

  3. Edit config/docs.php file to set your configuration parameters.

  4. Create or edit .env file to set your environment parameters (even though the project doesn't use database).

Usage

Laravel 5 Docs Reader automatically parses md files found in /docs folder.

Credits

Laravel 5 Docs Reader is using Twitter Bootstrap v.3.3.5 CSS and Parsedown PHP Markdown Parser.

License

This software is open-sourced software license under the MIT license