Emil is a static site generator based on Laravel.

Fund package maintenance!
happytodev

v2.0.4 2024-08-20 22:36 UTC

This package is auto-updated.

Last update: 2024-10-20 23:01:03 UTC


README

Latest Version on Packagist GitHub Tests Action Status GitHub Code Style Action Status Total Downloads

Emil is a static site generator made with Laravel. Use simply markdown files, Blade templating, TailwindCss to build your website.

Support us

You can support Emil by sponsoring it.

Installation

Prerequisites

Emil needs a fresh Laravel installation :

laravel new youramazingwebsite

You can install the package via composer:

composer require happytodev/emil

Launch the install :

php artisan emil:install
npm install && npm run dev

Usage

You can build you content in the content folder.

You can modify the appearence of your website by modifying resources/views folder.

Generate static content

Use this command :

php artisan emil:generate

Emil development server

You can see your modification in live by using the integrate Emil server.

php artisan emil:serve

In the background, Emil launch Browser-Sync and watches all files in content and resources/views folders.

On every detected change, it generates in _html folder :

  • css/main.css file
  • all html files

and of course, refresh the view in the browser.

Deployment

When your are satisfied, just push the content of _html folder on your server and voilà !

Testing

To be documented

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

License

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