benbjurstrom/prezet

Prezet: Markdown Blogging for Laravel

v0.2.0 2024-05-14 18:03 UTC

Requires

• php: ^8.2
• ext-dom: *
• ext-gd: *
• archtechx/laravel-seo: ^0.10.1
• illuminate/contracts: ^10.0||^11.0
• league/commonmark: ^2.4
• spatie/laravel-package-tools: ^1.16
• wendelladriel/laravel-validated-dto: ^3.5

Requires (Dev)

• larastan/larastan: ^2.9
• laravel/pint: ^1.14
• nunomaduro/collision: ^8.1.1||^7.10.0
• orchestra/testbench: ^9.0.0||^8.22.0
• pestphp/pest: ^2.34
• pestphp/pest-plugin-arch: ^2.7
• pestphp/pest-plugin-laravel: ^2.3
• phpstan/extension-installer: ^1.3
• phpstan/phpstan-deprecation-rules: ^1.1
• phpstan/phpstan-phpunit: ^1.3
• spatie/browsershot: ^4.0

MIT

• Ben Bjurstrom

• laravel
• prezet

README

Prezet: Markdown Blogging for Laravel

Transform your markdown files into SEO-friendly blogs, articles, and documentation with Prezet. Including built in automatic image optimization, dynamic tables of contents, validated front matter DTOs, and integrated Blade components.

Table of contents

• Features
• Quick Start
• Documentation

🌟 Features

• Installs in seconds: Set up your project with a single command.
• Automatic Image Optimization: Streamline your media with automated compression, WebP conversion, and responsive srcset handling.
• Dynamic Table of Contents: Automatically generate a nested, scroll-synced TOC from your article's H2 and H3 headings.
• Validated Frontmatter: Validate and cast frontmatter data into structured DTOs for consistency across your content.
• SUMMARY.md Support: Organize your blog level hierarchy with simple headings and links.
• Configurable Markdown: Tailor CommonMark extensions, route settings, and front matter DTOs through the package's configuration file.
• 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 on top of modular action classes allowing you full customization of the package's built in controllers.

🚀 Quick start

Create a fresh Laravel install

composer create-project laravel/laravel prezet
cd prezet
git init && git add . && git commit -m "Initial commit"

Install the Prezet package:

composer require benbjurstrom/prezet

Run the package installer:

⚠️ NOTE: Before running the installer on an existing application it is recommended to switch to a clean branch. As part of the install process Prezet configures your application with Tailwind CSS. Any existing Tailwind configuration will be overwritten.

php artisan prezet:install

Start your server:

php artisan serve

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

Documentation

Access detailed documentation at prezet.com

Credits

• Ben Bjurstrom
• All Contributors

License

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