README

A tiny markdown blog package for Laravel

Quickly add a Markdown blog to your Laravel app.

Installation

You can install the package via composer:

composer require geowrgetudor/laravel-tiny-blog

Initialize the blog by running the following command. A directory called content will be create in the root of your project. That's where your markdown article will be stored.

php artisan tinyblog:init

Publish the assets:

php artisan tinyblog:publish

Publish the config file and configure it however you like it:

php artisan vendor:publish --tag="tiny-blog-config"

If you want some sample articles, you can publish our examples using:

php artisan tinyblog:example

Optionally, you can publish the views to customize and/or extend them

php artisan vendor:publish --tag="tiny-blog-views"

Creating new articles

use Geow\TinyBlog\Models\Article;

Article::create([
    'title' => 'My first article',
    'description' => 'Trying out Tiny Blog',
    'img' => 'https://images.unsplash.com/photo-1682686579688-c2ba945eda0e?q=80&w=500&auto=format&fit=crop',
    'content' => '## Hello world', // should be markdown content
    'author' => 'George Tudor',
    'date' => now()->toDateTimeString(),
]);

Views

You can access the blog at your-domain.com/blog. You can change the route name in tiny-config.php config file.

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

• George Tudor
• All Contributors

License

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