spatie/laravel-markdown

A highly configurable markdown renderer and Blade component for Laravel

Fund package maintenance!
spatie

Installs: 3 465

Dependents: 0

Suggesters: 0

Security: 0

Stars: 123

Watchers: 2

Forks: 7

2.0.1 2021-09-13 07:47 UTC

This package is auto-updated.

Last update: 2021-09-13 07:47:35 UTC


README

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

This package contains:

  • a Blade component that can render markdown
  • a highly configurable class that you can use to render markdown

Let's start with an example of the provided x-markdown Blade component. This chunk of markdown...

<x-markdown>
# My title

This is a [link to our website](https://spatie.be)

```php
echo 'Hello world';
```
</x-markdown>

... will be converted by to component to this chunk of HTML:

<div>
    <h1 id="my-title">My title</h1>
    <p>This is a <a href="https://spatie.be">link to our website</a></p>
    <pre class="shiki" style="background-color: #fff"><code><span class="line"><span
        style="color: #005CC5">echo</span><span style="color: #24292E"> </span><span style="color: #032F62">&#39;Hello world&#39;</span><span
        style="color: #24292E">;</span></span>
<span class="line"></span></code></pre>
</div>

You can also programmatically render HTML.

// by resolving the class out of the container all the options
// in the config file will be used.

app(Spatie\LaravelMarkdown\MarkdownRenderer::class)->toHtml($markdown);

Out of the box, the x-markdown component and MarkdownRenderer can:

  • highlight code blocks correctly (via Shiki PHP) for 100+ languages, including PHP, JS, Blade, and many more.
  • add anchor links to headings
  • cache results to increase performance

Support us

68747470733a2f2f6769746875622d6164732e73332e65752d63656e7472616c2d312e616d617a6f6e6177732e636f6d2f6c61726176656c2d6d61726b646f776e2e6a70673f743d31

We invest a lot of resources into creating best in class open source packages. You can support us by buying one of our paid products.

We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on our contact page. We publish all received postcards on our virtual postcard wall.

Documentation

You can find installation instructions and detailed instructions on how to use this package at the dedicated documentation site.

Related packages

If you only need the league/commonmark extension to highlight code, head over to spatie/commonmark-shiki-highlighter.

In case you don't need the markdown support, but want to highlight code directly, take a look at spatie/shiki-php.

Testing

composer test

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

Alternatives

If you don't want to install and handle Shiki yourself, take a look at Torchlight, which can highlight your code with minimal setup.

License

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