code format docs

.github/workflows/docs_check.yml → .github/workflows/docs-check.yml

@@ -41,7 +41,7 @@ jobs:
                 dependency-versions: ${{ matrix.dependencies }}
 
             - name: "extract php code"
-              run: "bin/extract-php-code-from-docs"
+              run: "bin/docs-extract-php-code"
 
             - name: "lint php"
               run: "php -l docs_php/*.php"

Makefile

@@ -77,5 +77,8 @@ benchmark-diff-test: vendor                                                   	#
 dev: static test                                                                ## run dev tools
 
 .PHONY: docs
-docs:                                                                           ## run mkdocs
-	cd docs && mkdocs serve
+docs: mkdocs                                                                          ## run mkdocs
+	cd docs && python3 -m mkdocs serve
+
+mkdocs:                                                                         ## run mkdocs
+	cd docs && pip3 install -r requirements.txt

bin/extract-php-code-from-docs → bin/docs-extract-php-code

@@ -2,22 +2,18 @@
 <?php
 
 use League\CommonMark\Environment\Environment;
-use League\CommonMark\Extension\CommonMark\CommonMarkCoreExtension;
 use League\CommonMark\Extension\CommonMark\Node\Block\FencedCode;
-use League\CommonMark\Extension\GithubFlavoredMarkdownExtension;
 use League\CommonMark\Node\Query;
 use League\CommonMark\Parser\MarkdownParser;
+use Wnx\CommonmarkMarkdownRenderer\MarkdownRendererExtension;
 
 require __DIR__ . '/../vendor/autoload.php';
 
-
 $environment = new Environment([]);
-$environment->addExtension(new CommonMarkCoreExtension());
-$environment->addExtension(new GithubFlavoredMarkdownExtension());
+$environment->addExtension(new MarkdownRendererExtension());
 
 $parser = new MarkdownParser($environment);
 
-$path = __DIR__ . '/../docs/pages/subscription.md';
 $targetDir = __DIR__ . '/../docs_php';
 
 if (file_exists($targetDir)) {
@@ -53,7 +49,5 @@ foreach ($finder as $file) {
 
         $targetPath = $targetDir . '/' . $fileName . '_' . $node->getStartLine() . '.php';
         file_put_contents($targetPath, $code);
-
-        $node->setLiteral($source);
     }
 }

bin/docs-inject-php-code

@@ -0,0 +1,63 @@
+#!/usr/bin/env php
+<?php
+
+use League\CommonMark\Environment\Environment;
+use League\CommonMark\Extension\CommonMark\Node\Block\FencedCode;
+use League\CommonMark\Node\Query;
+use League\CommonMark\Parser\MarkdownParser;
+use Wnx\CommonmarkMarkdownRenderer\MarkdownRendererExtension;
+use Wnx\CommonmarkMarkdownRenderer\Renderer\MarkdownRenderer;
+
+require __DIR__ . '/../vendor/autoload.php';
+
+
+
+$environment = new Environment([]);
+$environment->addExtension(new MarkdownRendererExtension());
+
+$parser = new MarkdownParser($environment);
+$markdownRenderer = new MarkdownRenderer($environment);
+
+$targetDir = __DIR__ . '/../docs_php';
+
+if (!file_exists($targetDir)) {
+    exit(1);
+}
+
+$finder = new Symfony\Component\Finder\Finder();
+$finder->files()->in(__DIR__ . '/../docs/pages')->name('*.md');
+
+foreach ($finder as $file) {
+    $fileName = pathinfo($file->getBasename(), PATHINFO_FILENAME);
+
+    $content = file_get_contents($file->getPathname());
+    $document = $parser->parse($content);
+
+    $result = (new Query())
+        ->where(Query::type(FencedCode::class))
+        ->findAll($document);
+
+    /**
+     * @var FencedCode $node
+     */
+    foreach ($result as $node) {
+        if ($node->getInfo() !== 'php') {
+            continue;
+        }
+
+        $targetPath = $targetDir . '/' . $fileName . '_' . $node->getStartLine() . '.php';
+        $code = file_get_contents($targetPath);
+
+        $lines = explode("\n", $code);
+        array_splice($lines, 0, 2);
+        $code = implode("\n", $lines);
+
+        $node->setLiteral(trim($code));
+    }
+
+    file_put_contents($file->getPathname(), $markdownRenderer->renderDocument($document));
+}
+
+if (file_exists($targetDir)) {
+    exec('rm -rf ' . $targetDir);
+}