Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add inline Blade support to Markdown #478

Merged
merged 23 commits into from
May 31, 2022

Conversation

caendesilva
Copy link
Member

@caendesilva caendesilva commented May 31, 2022

Introduction

Since HydePHP makes heavy use of Markdown there are some extra features and helpers
created just for Hyde to make using Markdown even easier!

Fixes #463

Blade Support

Since Hyde v0.30.x you can use Laravel Blade in Markdown files!

Using Blade in Markdown

To use Blade in your Markdown files, simply use the Blade shortcode directive,
followed by your desired Blade string.

Standard syntax

 [Blade]: {{ "Hello World!" }} // Will render: 'Hello World!'

Blade includes

Only single-line shortcode directives are supported. If you need to use multi-line Blade code,
use an @include directive to render a more complex Blade template.
You can pass data to includes by specifying an array to the second argument.

 [Blade]: @include("hello-world")
 [Blade]: @include("hello", ["name" => "World"])

Enabling Blade-supported Markdown

It's disabled by default since it allows arbitrary PHP to run, which could be a security risk,
depending on your setup. However, if your Markdown is trusted, and you know it's safe,
you can enable it in the config/markdown.php file.

// torchlight! {"lineNumbers": false}
'enable_blade' => true,

Limitations

All shortcodes must be the first word on a new line.
For example, using a space before the [Blade]: will intentionally cause it to not render.

@caendesilva caendesilva linked an issue May 31, 2022 that may be closed by this pull request
@caendesilva caendesilva merged commit fd41cf7 into master May 31, 2022
@caendesilva caendesilva deleted the add-blade-support-for-markdown branch May 31, 2022 15:14
@caendesilva caendesilva changed the title Add inline Blade support to markdown Add inline Blade support to Markdown May 31, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add support for using Blade directives in Markdown files
2 participants