Install via composer.
$ composer require olliecodes/laravel-etched-blade
Once installed you'll want to publish the config.
$ php artisan vendor:publish --provider="\OllieCodes\Etched\EtchedServiceProvider" --tag=config
If you want to modify the default themes you can publish those too.
$ php artisan vendor:publish --provider="\OllieCodes\Etched\EtchedServiceProvider" --tag=views
This package requires the following;
- PHP >= 7.3 (Including 8).
illuminate/view>= 8.0 < 9.0 - The view component from Laravel.
league/commonmark>= 1.6 < 2.0 - The PHP league commonmark library, used for parsing the Markdown.
webuni/front-matter>= 1.2 < 2.0 - The front matter parser.
To render markdown in your blade files you can either do it inline;
@etched # I am a heading This is some content - I am a list - So am I but more - I'm the same - I'm less than those two @endetched
Or by including a markdown file (
The above references the file
markdown/content/article-1.md, and the file will be rendered by etched the same way that blade files normally are.
You can control the theme used for the rendered markdown in several ways.
Provide it as an argument on the directive.
@etched('simple') ... @endetched
As an argument when including.
@include('markdown-file', ['theme' => 'simple'])
Or in the front-matter of the markdown.
--- theme: simple --- I am some content
If no theme is provided the value of
etched.defaults.theme is used instead. If multiple are provided, the value from the front-matter will take precedence.
All markdown rendering is handled by the
You can use this method on an instance of
Or using the facade.
The second parameter
$theme is optional and will default to the config value
etched.defaults.theme. The theme will be overridden by the front-matter value if one is provided in the markdown content.