Skip to content

Add Laravel 11.x Docs #110

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

Merged
merged 5 commits into from
Apr 13, 2024
Merged
Changes from all commits
Commits
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
7 changes: 4 additions & 3 deletions app/Docs.php
Original file line number Diff line number Diff line change
@@ -2,6 +2,7 @@

namespace App;

use App\Markdown\GithubFlavoredMarkdownConverter;
use App\Models\Document;
use App\Models\DocumentationSection;
use Exception;
@@ -19,7 +20,7 @@ class Docs
/**
* Default version of Laravel documentation
*/
public const DEFAULT_VERSION = '10.x';
public const DEFAULT_VERSION = '11.x';

/**
* Array of supported versions
@@ -115,11 +116,11 @@ public function variables(?string $key = null): mixed
public function content(): ?string
{
return once(function () {
return Str::of($this->raw())
return (new GithubFlavoredMarkdownConverter())->convert(Str::of($this->raw())
->replace('{{version}}', $this->version)
->after('---')
->after('---')
->markdown();
);
});
}

39 changes: 39 additions & 0 deletions app/Markdown/GithubFlavoredMarkdownConverter.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
<?php

namespace App\Markdown;

use Laravel\Unfenced\UnfencedExtension;
use League\CommonMark\Environment\Environment;
use League\CommonMark\Environment\EnvironmentInterface;
use League\CommonMark\Extension\Attributes\AttributesExtension;
use League\CommonMark\Extension\CommonMark\CommonMarkCoreExtension;
use League\CommonMark\MarkdownConverter;

/**
* Converts GitHub Flavored Markdown to HTML.
*/
class GithubFlavoredMarkdownConverter extends MarkdownConverter
{
/**
* Create a new Markdown converter pre-configured for GFM
*
* @param array<string, mixed> $config
*/
public function __construct(array $config = [])
{
$environment = new Environment($config);
$environment->addExtension(new CommonMarkCoreExtension());
$environment->addExtension(new GithubFlavoredMarkdownExtension());
$environment->addExtension(new UnfencedExtension());
$environment->addExtension(new AttributesExtension());

parent::__construct($environment);
}

public function getEnvironment(): EnvironmentInterface
{
\assert($this->environment instanceof EnvironmentInterface);

return $this->environment;
}
}
21 changes: 21 additions & 0 deletions app/Markdown/GithubFlavoredMarkdownExtension.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
<?php

namespace App\Markdown;

use League\CommonMark\Environment\EnvironmentBuilderInterface;
use League\CommonMark\Extension\Autolink\AutolinkExtension;
use League\CommonMark\Extension\ExtensionInterface;
use League\CommonMark\Extension\Strikethrough\StrikethroughExtension;
use League\CommonMark\Extension\Table\TableExtension;
use League\CommonMark\Extension\TaskList\TaskListExtension;

final class GithubFlavoredMarkdownExtension implements ExtensionInterface
{
public function register(EnvironmentBuilderInterface $environment): void
{
$environment->addExtension(new AutolinkExtension());
$environment->addExtension(new StrikethroughExtension());
$environment->addExtension(new TableExtension());
$environment->addExtension(new TaskListExtension());
}
}
7 changes: 7 additions & 0 deletions composer.json
Original file line number Diff line number Diff line change
@@ -34,6 +34,7 @@
"laravel/socialite": "^5.9",
"laravel/telescope": "^5.0",
"laravel/tinker": "^2.8",
"laravel/unfenced": "dev-main",
"orchid/platform": "^14.17",
"overtrue/laravel-like": "^5.2",
"spatie/laravel-activitylog": "^4.7",
@@ -54,6 +55,12 @@
"spatie/laravel-ignition": "^2.0",
"vimeo/psalm": "^5.23"
},
"repositories": [
{
"type": "vcs",
"url": "git@github.com:laravel-labs/unfenced.git"
}
],
"autoload": {
"psr-4": {
"App\\": "app/",
Loading