Prezet Installation Guide

This guide will walk you through the process of installing Prezet, a powerful markdown blogging framework for Laravel.

#Installation Steps

#1: Install the Prezet Framework

Install the core Prezet framework package using Composer:

composer require prezet/prezet

#2: Run the Framework Installer

Run the Prezet framework installer using the following Artisan command:

php artisan prezet:install

This command sets up the core Prezet functionality by:

Adding the prezet SQLite database connection to config/database.php
Creating the prezet storage disk in config/filesystems.php
Publishing the Prezet configuration file
Building the initial search index from your markdown content

Note that the installer will not proceed if your git directory is not clean. Use `prezet:install --force` to bypass this restriciton.

#3: Install a Frontend Template

The Prezet framework provides the backend engine. You'll need to install a separate template package to provide the frontend (routes, controllers, views, CSS). These templates also provide some sample content to work with while setting things up.

Check out our official template packages:

# Install the template package
composer require prezet/blog-template --dev

# Run the template's installer
php artisan blog-template:install

Existing Configuration Files

The template installer might overwrite existing files like vite.config.js and postcss.config.js. Ensure you have backups before proceeding if you have customized these files.

#4: Start Your Server

Once the installation is complete, you can start your Laravel development server:

php artisan serve

After starting your server, you can verify the installation by visiting:

http://localhost:8000/prezet

You should now see your new markdown blog powered by Prezet!

#Refreshing the SQLite Index

After installing Prezet and setting up your initial content, it's important to refresh the SQLite index by running the following command:

php artisan prezet:index --fresh

For more information about the SQLite index see the Prezet Index documentation.

#Next Steps

Now that Prezet is installed, explore these topics:

Content Creation:

Markdown Features - Writing and formatting content
Blade Components - Using Laravel components in markdown
Image Optimization - Responsive image handling

Customization:

Configuration - Adjust Prezet's behavior
Routes - Define custom URL patterns
Front Matter - Add custom metadata fields