benbjurstrom/prezet

Prezet: Markdown Blogging for Laravel

v1.0.0-rc6 2025-02-26 18:13 UTC

Requires

• php: ^8.2
• ext-dom: *
• ext-gd: *
• benbjurstrom/laravel-sitemap-lite: ^7.3.1
• illuminate/contracts: ^10.0||^11.0||^12.0
• league/commonmark: ^2.6.1
• spatie/laravel-package-tools: ^1.16
• symfony/yaml: ^6.2|^7.1
• wendelladriel/laravel-validated-dto: ^4.0

Requires (Dev)

• larastan/larastan: 2.9.8
• laravel/pint: ^1.20
• nunomaduro/collision: ^8.6
• orchestra/testbench: ^9.9
• pestphp/pest: ^3.7
• pestphp/pest-plugin-arch: ^3.0
• pestphp/pest-plugin-laravel: ^3.1
• phpstan/extension-installer: ^1.4.3
• phpstan/phpstan: 1.12.2
• phpstan/phpstan-deprecation-rules: ^1.1
• phpstan/phpstan-phpunit: 1.4.2
• spatie/browsershot: ^4.0

MIT

• Ben Bjurstrom

• laravel
• prezet

README

Prezet: Markdown Blogging for Laravel

Go from markdown files to SEO-friendly blogs, articles, and documentation in seconds!

prezethd.mov

Table of contents

• Features
• Quick Start
• Documentation

🌟 Features

✅ Installs in seconds
Set up your project with a single command.

✅ Automatic Image Optimization
Automated image compression, scaling, and responsive srcset handling.

✅ SQLite Index
Indexes your markdown files to support search, pagination, sorting, and filtering.

✅ Validated Front Matter
Cast front matter into validated DTOs for consistency across your content.

✅ Open Graph (OG) images
Generate OG images from front matter using a customizable template.

✅ Dynamic Table of Contents
Automatically generate a nested, scroll-synced TOC from your article's headings.

✅ SEO Optimization
Automatically generate meta tags based on front matter data for better search engine discoverability.

✅ Blade Components
Include Laravel Blade components in your markdown for enriched, interactive content.

✅ Complete Customization
Prezet is built to allow full customization of your routes, front matter, and blade templates.

🚀 Quick start

Install the Prezet package:

composer require benbjurstrom/prezet:1.0.0-rc6

Run the package installer:

⚠️ NOTE: For existing applications it is recommended to switch to a clean branch so you can review the changes Prezet made during the installation process.

php artisan prezet:install

or if you prefer Tailwind v3

artisan prezet:install --tailwind3

Update the index:

After adding or modifying your markdown files, you need to update the index to reflect these changes:

php artisan prezet:index --fresh

This command updates the SQLite index with the latest front matter information from your markdown files. Run this command whenever you:

• Add a new markdown file
• Change a markdown file's slug
• Modify front matter and want to see those changes reflected on the index page

Note that changes to the main content of your markdown files don't require updating the index, as this content is read directly from the file when displaying a single post.

Start your server:

php artisan serve

Check out your new markdown blog at http://localhost:8000/prezet

Documentation

Detailed documentation available at prezet.com

Credits

• Ben Bjurstrom
• All Contributors

License

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