[FEATURE] Create a rst theme to convert markdown

linawolf · linawolf · commit 619936e69aa9 · 2024-10-12T02:40:15.000+02:00
Convert basic mark-down into restructured Text

* code-blocks
diff --git a/packages/guides-theme-rst/resources/template/rst/body/code.rst.twig b/packages/guides-theme-rst/resources/template/rst/body/code.rst.twig
@@ -1,3 +1,3 @@
-```
-{{ node.value|raw }}
-```
+..  code-block:: plaintext
+
+{{ renderRstIndent(node.value|raw, 1)|raw }}
diff --git a/packages/guides-theme-rst/src/RstTheme/Twig/RstExtension.php b/packages/guides-theme-rst/src/RstTheme/Twig/RstExtension.php
@@ -39,9 +39,16 @@ public function getFunctions(): array
     {
         return [
             new TwigFunction('renderRstTitle', $this->renderRstTitle(...), ['is_safe' => ['rst'], 'needs_context' => false]),
+            new TwigFunction('renderRstIndent', $this->renderRstIndent(...), ['is_safe' => ['rst'], 'needs_context' => false]),
         ];
     }
 
+    public function renderRstIndent(string $text, int $indentNr): string
+    {
+        $indent = str_repeat(' ', $indentNr*4);
+        return preg_replace('/^/m', $indent, $text);
+    }
+
     public function renderRstTitle(TitleNode $node, string $content): string
     {
         $headerSyntax = HeaderSyntax::from(min($node->getLevel(), 6));
diff --git a/tests/Integration/tests-full/md-to-rst/code-md-to-rst/expected/index.rst b/tests/Integration/tests-full/md-to-rst/code-md-to-rst/expected/index.rst
@@ -0,0 +1,41 @@
+=========================
+Markdown with Code Blocks
+=========================
+
+..  code-block:: plaintext
+
+    <html>
+      <head>
+      </head>
+    </html>
+
+
+Fenced Code Blocks
+==================
+
+..  code-block:: plaintext
+
+    {
+      "firstName": "John",
+      "lastName": "Smith",
+      "age": 25
+    }
+
+
+
+
+Fenced Code Block with caption
+==============================
+
+..  code-block:: plaintext
+
+    procedure startSwinging(swing, child)
+       while child.isComfortable()
+           swing.giveGentlePush()
+           waitForNextIteration()
+       end while
+    end procedure
+
+
+
+
diff --git a/tests/Integration/tests-full/md-to-rst/code-md-to-rst/input/guides.xml b/tests/Integration/tests-full/md-to-rst/code-md-to-rst/input/guides.xml
@@ -0,0 +1,11 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<guides xmlns="https://www.phpdoc.org/guides"
+        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xsi:schemaLocation="https://www.phpdoc.org/guides packages/guides-cli/resources/schema/guides.xsd"
+        input-format="md"
+        theme="rst"
+>
+    <project title="Project Title" version="6.4"/>
+    <extension class="phpDocumentor\Guides\RstTheme"/>
+    <output-format>rst</output-format>
+</guides>
diff --git a/tests/Integration/tests-full/md-to-rst/code-md-to-rst/input/index.md b/tests/Integration/tests-full/md-to-rst/code-md-to-rst/input/index.md
@@ -0,0 +1,26 @@
+# Markdown with Code Blocks
+
+    <html>
+      <head>
+      </head>
+    </html>
+
+## Fenced Code Blocks
+
+```
+{
+  "firstName": "John",
+  "lastName": "Smith",
+  "age": 25
+}
+```
+
+## Fenced Code Block with caption
+
+```pseudocode
+procedure startSwinging(swing, child)
+   while child.isComfortable()
+       swing.giveGentlePush()
+       waitForNextIteration()
+   end while
+end procedure

Original file line number	Diff line number	Diff line change
`@@ -39,9 +39,16 @@ public function getFunctions(): array`
`39`	`39`	`{`
`40`	`40`	`return [`
`41`	`41`	`new TwigFunction('renderRstTitle', $this->renderRstTitle(...), ['is_safe' => ['rst'], 'needs_context' => false]),`
	`42`	`+ new TwigFunction('renderRstIndent', $this->renderRstIndent(...), ['is_safe' => ['rst'], 'needs_context' => false]),`
`42`	`43`	`];`
`43`	`44`	`}`
`44`	`45`
	`46`	`+ public function renderRstIndent(string $text, int $indentNr): string`
	`47`	`+ {`
	`48`	`+ $indent = str_repeat(' ', $indentNr*4);`
	`49`	`+ return preg_replace('/^/m', $indent, $text);`
	`50`	`+ }`
	`51`	`+`
`45`	`52`	`public function renderRstTitle(TitleNode $node, string $content): string`
`46`	`53`	`{`
`47`	`54`	`$headerSyntax = HeaderSyntax::from(min($node->getLevel(), 6));`