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.

Sign up for GitHub

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

Jump to bottom

Render special blockquotes on the backend #351

Merged
merged 3 commits into from
Jul 16, 2024
Merged

Render special blockquotes on the backend #351

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
eea74e4
Render blockquotes on the server
timacdonald Jul 15, 2024
06b6a21
Compile Assets
timacdonald Jul 15, 2024
34f490a
Formatting
timacdonald Jul 15, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
93 changes: 93 additions & 0 deletions app/Markdown/BlockQuoteRenderer.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
<?php

namespace App\Markdown;

use Illuminate\Support\Facades\Vite;
use Illuminate\Support\Str;
use League\CommonMark\Extension\CommonMark\Renderer\Block\BlockQuoteRenderer as BaseBlockQuoteRenderer;
use League\CommonMark\Node\Node;
use League\CommonMark\Renderer\ChildNodeRendererInterface;
use League\CommonMark\Renderer\NodeRendererInterface;
use League\CommonMark\Util\HtmlElement;

class BlockQuoteRenderer implements NodeRendererInterface
{
/**
* @return \Stringable|string|null
*/
public function render(Node $node, ChildNodeRendererInterface $childRenderer)
{
$element = (new BaseBlockQuoteRenderer($node))->render($node, $childRenderer);

if (
! $element instanceof HtmlElement ||
$element->getTagName() !== 'blockquote'
) {
return $element;
}

$html = trim($element->getContents(true));

if (! str_starts_with($html, '<p>')) {
return $element;
}

$paragraphPartial = Str::after($html, '<p>');

if (preg_match('/^\[!(NOTE|WARNING)\](?:<br \/>)?/', $paragraphPartial, $matches) === 1) {
// GitHub styled notes, e.g.,
// > [!NOTE] Content
// or
// > [!NOTE]
// > Content

[$asset, $class] = match ($matches[1]) {
'WARNING' => [Vite::content('resources/images/exclamation.svg'), 'bg-red-600'],
'NOTE' => [Vite::content('resources/images/lightbulb.svg'), 'bg-purple-600'],
};
} elseif (preg_match('/^<strong>(Note|Warning):?<\/strong>:?(?:<br \/>)?/', $paragraphPartial, $matches) === 1) {
// Legacy GitHub styled notes, e.g.,
// > **Note:** Content
// or
// > **Note**: Content
// or
// > **Note** Content
// or
// > **Note:**
// > Content
// or
// > **Note**:
// > Content
// or
// > **Note**
// > Content

[$asset, $class] = match ($matches[1]) {
'Warning' => [Vite::content('resources/images/exclamation.svg'), 'bg-red-600'],
'Note' => [Vite::content('resources/images/lightbulb.svg'), 'bg-purple-600'],
};
} elseif (preg_match('/^\{(note|tip|video)\}/', $paragraphPartial, $matches) === 1) {
// Legacy Laravel styled notes, e.g.,
// > {tip} Content

[$asset, $class] = match ($matches[1]) {
'note' => [Vite::content('resources/images/exclamation.svg'), 'bg-red-600'],
'tip' => [Vite::content('resources/images/lightbulb.svg'), 'bg-purple-600'],
'video' => [Vite::content('resources/images/laracast.svg'), 'bg-blue-600'],
};
} else {
return $element;
}

$paragraphPartial = str_replace($matches[0], '', $paragraphPartial);

return <<<HTML
<div class="mb-10 max-w-2xl mx-auto px-4 py-8 shadow-lg lg:flex lg:items-center callout">
<div class="w-20 h-20 mb-6 flex items-center justify-center shrink-0 lg:mb-0 {$class}">
<div class="opacity-75">{$asset}</div>
</div>
<p class="mb-0 lg:ml-6 callout">{$paragraphPartial}
</div>
HTML;
}
}
18 changes: 17 additions & 1 deletion app/Markdown/GithubFlavoredMarkdownConverter.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,25 @@

namespace App\Markdown;

use Illuminate\Support\Str;
use League\CommonMark\Extension\Autolink\AutolinkExtension;
use League\CommonMark\Extension\Strikethrough\StrikethroughExtension;
use League\CommonMark\Extension\Table\TableExtension;
use League\CommonMark\Extension\TaskList\TaskListExtension;
use League\CommonMark\MarkdownConverter;
use League\CommonMark\Environment\Environment;
use App\Markdown\GithubFlavoredMarkdownExtension;
use Illuminate\Support\Facades\Vite;
use League\CommonMark\Node\Node;
use League\CommonMark\Renderer\ChildNodeRendererInterface;
use League\CommonMark\Util\HtmlElement;
use Torchlight\Commonmark\V2\TorchlightExtension;
use Laravel\Unfenced\UnfencedExtension;
use League\CommonMark\Environment\EnvironmentInterface;
use League\CommonMark\Extension\Attributes\AttributesExtension;
use League\CommonMark\Extension\CommonMark\CommonMarkCoreExtension;
use League\CommonMark\Extension\CommonMark\Node\Block\BlockQuote;
use League\CommonMark\Renderer\NodeRendererInterface;

/**
* Converts GitHub Flavored Markdown to HTML.
Expand All @@ -25,11 +36,16 @@ public function __construct(array $config = [])
{
$environment = new Environment($config);
$environment->addExtension(new CommonMarkCoreExtension());
$environment->addExtension(new GithubFlavoredMarkdownExtension());
$environment->addExtension(new AutolinkExtension());
$environment->addExtension(new StrikethroughExtension());
$environment->addExtension(new TableExtension());
$environment->addExtension(new TaskListExtension());
Comment on lines -28 to +42
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've inlined the extensions previously added in the extracted GithubFlavoredMarkdownExtension class.

$environment->addExtension(new UnfencedExtension());
$environment->addExtension(new AttributesExtension());
$environment->addExtension(new TorchlightExtension());

$environment->addRenderer(BlockQuote::class, new BlockQuoteRenderer());

parent::__construct($environment);
}

Expand Down
21 changes: 0 additions & 21 deletions app/Markdown/GithubFlavoredMarkdownExtension.php
View file
Open in desktop

This file was deleted.

Loading