README

This package provides a documentation-focused starting template for the Prezet Markdown Blogging Engine [1]. It sets up routes, controllers, views, CSS, and content structure suitable for project documentation.

The installer copies the necessary files into your Laravel application and then removes this package, leaving you with the template files to modify as needed.

Installation

1. Require the package:

   composer require prezet/docs-template --dev

   (Note: We install as a dev dependency since the package removes itself after installation).

2. Run the installer:

   php artisan docs-template:install

   This command will:

   • Copy routes, controllers, views, CSS, content stubs, and Vite configuration into your application.
   • Install required Node dependencies (tailwindcss, alpinejs, etc.).
   • Remove the prezet/docs-template package from your Composer dependencies.

Files Added/Modified

The docs-template:install command will add or modify the following files and directories within your Laravel application:

your-laravel-app/
├── app/
│   └── Http/
│       └── Controllers/
│           └── Prezet/     # Contains the index, show, image, ogimage, and search controllers
├── routes/
│   ├── prezet.php          # Route definitions for the above controllers
│   └── web.php             # Modified to include routes/prezet.php
├── resources/
│   ├── css/
│   │   └── prezet.css      # Contains the Tailwind v4 CSS
│   └── views/
│       ├── components/
│       │   └── prezet/     # A collection of Blade components used in the documentation
│       └── prezet/         # Page level Blade views for the index, show, and ogimage routes
├── prezet/                 # Example content containng markdown files and images
├── package.json            # Modified with added node dependencies
└── vite.config.js          # Overwrites existing vite.config.js. Be sure to check this file.

Testing

composer test

Credits

• Ben Bjurstrom
• All Contributors

License

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