xiaotianhu/markdoc

There is no license information available for the latest version (dev-master) of this package.

dev-master 2019-09-05 05:52 UTC

Unknown License

• rainyluo

README

An markdown based document viewer for laravel , out-of-the-box

Screenshot

Installation

This package requires PHP 7+ and Laravel 5.5+

composer require xiaotianhu/markdoc

After that, publish the config files with:

php artisan markdoc:install

And we're done.

For older version of laravel,you may add the service provider in the file config/app.php:

Xiaotianhu\Markdoc\ServiceProvider::class

Usage

After the install,you'll find a doc folder in your project's base path.

Just put all the markdown files into the folder,and access with:

http://yoursite.com/markdoc/index

By default,you can only access the document when the laravel's debug mode is on;

You can modify this in the config file 'config/markdoc.php'.

License

The MIT License (MIT). Please see License File for more information.