Skip to content

Keep the frontmatter when formatting the docs #235

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

Merged
DavidBadura merged 1 commit into from
Oct 18, 2026
Merged

Keep the frontmatter when formatting the docs #235

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
11 changes: 11 additions & 0 deletions bin/docs-extract-php-code
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@

use League\CommonMark\Environment\Environment;
use League\CommonMark\Extension\CommonMark\Node\Block\FencedCode;
use League\CommonMark\Extension\FrontMatter\Data\FrontMatterDataParserInterface;
use League\CommonMark\Extension\FrontMatter\FrontMatterExtension;
use League\CommonMark\Node\Query;
use League\CommonMark\Parser\MarkdownParser;
use Wnx\CommonmarkMarkdownRenderer\MarkdownRendererExtension;
Expand All @@ -11,6 +13,15 @@ require __DIR__ . '/../vendor/autoload.php';

$environment = new Environment([]);
$environment->addExtension(new MarkdownRendererExtension());
$environment->addExtension(new FrontMatterExtension(
// keep the raw YAML string so it round-trips byte-identically
new class implements FrontMatterDataParserInterface {
public function parse(string $frontMatter): string
{
return $frontMatter;
}
},
));

$parser = new MarkdownParser($environment);

Expand Down
21 changes: 20 additions & 1 deletion bin/docs-inject-php-code
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,9 @@

use League\CommonMark\Environment\Environment;
use League\CommonMark\Extension\CommonMark\Node\Block\FencedCode;
use League\CommonMark\Extension\FrontMatter\Data\FrontMatterDataParserInterface;
use League\CommonMark\Extension\FrontMatter\FrontMatterExtension;
use League\CommonMark\Extension\FrontMatter\Output\RenderedContentWithFrontMatter;
use League\CommonMark\Node\Query;
use League\CommonMark\Parser\MarkdownParser;
use Wnx\CommonmarkMarkdownRenderer\MarkdownRendererExtension;
Expand All @@ -14,6 +17,15 @@ require __DIR__ . '/../vendor/autoload.php';

$environment = new Environment([]);
$environment->addExtension(new MarkdownRendererExtension());
$environment->addExtension(new FrontMatterExtension(
// keep the raw YAML string so it round-trips byte-identically
new class implements FrontMatterDataParserInterface {
public function parse(string $frontMatter): string
{
return $frontMatter;
}
},
));

$parser = new MarkdownParser($environment);
$markdownRenderer = new MarkdownRenderer($environment);
Expand Down Expand Up @@ -62,7 +74,14 @@ foreach ($finder as $file) {
$node->setLiteral(trim($code));
}

file_put_contents($file->getPathname(), $markdownRenderer->renderDocument($document));
$rendered = $markdownRenderer->renderDocument($document);
$output = $rendered->getContent();

if ($rendered instanceof RenderedContentWithFrontMatter) {
$output = $rendered->getFrontMatter() . "---\n" . $output;
}

file_put_contents($file->getPathname(), $output);
}

if (file_exists($targetDir)) {
Expand Down
Loading