happytodev / emil
Emil is a static site generator based on Laravel.
Fund package maintenance!
happytodev
Requires
- php: ^8.2
- illuminate/contracts: ^11.0
- league/commonmark: ^2.4
- spatie/file-system-watcher: ^1.2
- spatie/image-optimizer: ^1.7
- spatie/laravel-package-tools: ^1.14.0
- symfony/yaml: ^6.4
Requires (Dev)
- larastan/larastan: ^2.0.1
- laravel/pint: ^1.0
- nunomaduro/collision: ^8.1
- orchestra/testbench: ^8.8
- pestphp/pest: ^2.20
- pestphp/pest-plugin-arch: ^2.5
- pestphp/pest-plugin-laravel: ^2.0
- phpstan/extension-installer: ^1.1
- phpstan/phpstan-deprecation-rules: ^1.0
- phpstan/phpstan-phpunit: ^1.0
This package is auto-updated.
Last update: 2024-10-20 23:01:03 UTC
README
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.