[FEATURE] Create a rst theme to convert markdown

Convert basic mark-down into restructured Text

* blockquote

packages/guides-theme-rst/resources/template/rst/body/code.rst.twig

@@ -1,3 +1,6 @@
 ..  code-block:: plaintext
 
 {{ renderRstIndent(node.value|raw, 1)|raw }}
+{{ "\n" }}
+{{ "\n" }}
+

packages/guides-theme-rst/resources/template/rst/body/list/list.rst.twig

@@ -1,9 +1,11 @@
+{{ "\n" }}
 {% if node.isOrdered -%}
     {%- for item in node.value -%}
-        #.  {{ renderNode(item.value)|raw }}{{ "\n\n" }}
+        #.  {{ renderNode(item.value)|raw }}{{ "\n" }}
     {% endfor -%}
 {%- else -%}
     {%- for item in node.value -%}
         *   {{ renderNode(item.value)|raw }}{{ "\n" }}
     {%- endfor -%}
-{%- endif -%}
+{%- endif %}
+{{ "\n" }}

packages/guides-theme-rst/resources/template/rst/body/paragraph.rst.twig

@@ -1,4 +1,6 @@
-{%- set text = renderNode(node.value)|raw -%}
+{% set text = renderNode(node.value)|raw -%}
 {%- if text|trim %}
     {{- text|raw -}}
 {% endif -%}
+{{ "\n" }}
+{{ "\n" }}

packages/guides-theme-rst/resources/template/rst/body/quote.rst.twig

@@ -1 +1,3 @@
-    {{ renderNode(node.value) }}
+{{ renderRstIndent(renderNode(node.value)|raw, 1)|raw }}
+{{ "\n" }}
+{{ "\n" }}

packages/guides-theme-rst/resources/template/rst/inline/image.rst.twig

@@ -1,2 +1,4 @@
-..  figure:: {{ node.url }}
-    :alt: {{ node.altText }}
+{{ "\n" }}
+..  figure:: {{ node.url|raw }}
+    :alt: {{ node.altText|raw }}
+{{ "\n" }}

packages/guides-theme-rst/resources/template/rst/inline/inline-node.rst.twig

@@ -1,3 +1,3 @@
 {%- for child in node.children -%}
-    {{- renderNode(child) -}}
+    {{- renderNode(child)|raw -}}
 {%- endfor -%}

packages/guides-theme-rst/resources/template/rst/inline/literal.rst.twig

@@ -1,5 +1,5 @@
 {%- if node.value matches '/`/' -%}
-    ``{{- node.value -}}``
+    ``{{- node.value|raw -}}``
 {%- else -%}
-    `{{- node.value -}}`
+    `{{- node.value|raw -}}`
 {%- endif -%}

packages/guides-theme-rst/resources/template/rst/structure/document.rst.twig

@@ -1,3 +1,7 @@
-{% for child in node.children -%}
-    {{- renderNode(child) -}}
-{%- endfor %}
+{%- set renderedContent -%}
+    {%- for child in node.children -%}
+        {{- renderNode(child) -}}
+    {%- endfor -%}
+{%- endset -%}
+
+{{- renderedContent | clean_content | raw -}}

packages/guides-theme-rst/src/RstTheme/Twig/RstExtension.php

@@ -19,6 +19,7 @@
 use phpDocumentor\Guides\RstTheme\Configuration\HeaderSyntax;
 use phpDocumentor\Guides\Twig\GlobalMenuExtension;
 use Twig\Extension\AbstractExtension;
+use Twig\TwigFilter;
 use Twig\TwigFunction;
 
 use function min;
@@ -43,6 +44,24 @@ public function getFunctions(): array
         ];
     }
 
+    /** @return TwigFilter[] */
+    public function getFilters(): array
+    {
+        return [
+            new TwigFilter('clean_content', [$this, 'cleanContent']),
+        ];
+    }
+
+    public function cleanContent(string $content): string
+    {
+        $lines = explode("\n", $content);
+        $lines = array_map('rtrim', $lines);
+        $content = implode("\n", $lines);
+
+        $content = preg_replace('/(\n){2,}/', "\n\n", $content);
+        return rtrim($content)."\n";
+    }
+
     public function renderRstIndent(string $text, int $indentNr): string
     {
         $indent = str_repeat(' ', $indentNr*4);

tests/Integration/tests-full/md-to-rst/blockquote-md-to-rst/expected/index.rst

@@ -0,0 +1,32 @@
+====================
+Markdown Blockquotes
+====================
+
+    This is a blockquote. It can span multiple lines.
+
+Blockquotes with Multiple Paragraphs
+====================================
+
+    Dorothy followed her through many of the beautiful rooms in her castle.
+
+    The Witch bade her clean the pots and kettles and sweep the floor and keep the fire fed with wood.
+
+Blockquotes with Other Elements
+===============================
+
+    The quarterly results look great!
+
+    *   Revenue was off the chart.
+
+    *   Profits were higher than ever.
+
+    *Everything* is going according to **plan**.
+
+Blockquotes Best Practices
+==========================
+
+Try to put a blank line before...
+
+    This is a blockquote
+
+...and after a blockquote.

tests/Integration/tests-full/md-to-rst/blockquote-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>

tests/Integration/tests-full/md-to-rst/blockquote-md-to-rst/input/index.md

@@ -0,0 +1,27 @@
+# Markdown Blockquotes
+
+> This is a blockquote.
+> It can span multiple lines.
+
+## Blockquotes with Multiple Paragraphs
+
+> Dorothy followed her through many of the beautiful rooms in her castle.
+>
+> The Witch bade her clean the pots and kettles and sweep the floor and keep the fire fed with wood.
+
+## Blockquotes with Other Elements
+
+> The quarterly results look great!
+>
+> - Revenue was off the chart.
+> - Profits were higher than ever.
+>
+> *Everything* is going according to **plan**.
+
+## Blockquotes Best Practices
+
+Try to put a blank line before...
+
+> This is a blockquote
+
+...and after a blockquote.

tests/Integration/tests-full/md-to-rst/code-md-to-rst/expected/index.rst

@@ -9,7 +9,6 @@ Markdown with Code Blocks
       </head>
     </html>
 
-
 Fenced Code Blocks
 ==================
 
@@ -21,9 +20,6 @@ Fenced Code Blocks
       "age": 25
     }
 
-
-
-
 Fenced Code Block with caption
 ==============================
 
@@ -35,7 +31,3 @@ Fenced Code Block with caption
            waitForNextIteration()
        end while
     end procedure
-
-
-
-

tests/Integration/tests-full/md-to-rst/emphasis-md-to-rst/expected/index.rst

@@ -3,4 +3,3 @@ Markdown with emphasis
 ======================
 
 *Italic* or *Italic* **Bold** or **Bold**
-

tests/Integration/tests-full/md-to-rst/index-md-to-rst/expected/index.rst

@@ -10,6 +10,3 @@ Headings
 You can create headings using hash symbols.
 
 This text is part of a paragraph under the "Headings" heading.
-
-
-

tests/Integration/tests-full/md-to-rst/inline-code-md-to-rst/expected/index.rst

@@ -5,4 +5,3 @@ Markdown with inline Code
 Lorem Ipsum Dolor: `$dolor`...
 
 ``Use `code` in your Markdown file.``
-

tests/Integration/tests-full/md-to-rst/md-to-rst-list-link/expected/index.rst

@@ -5,9 +5,10 @@ TYPO3 Extension powermail - Documentation
 This documentation helps
 
 *   Administrators to install and configure powermail
+
 *   Editors to use powermail
-*   Developers to extend powermail
 
+*   Developers to extend powermail
 
 Example Screenshots
 ===================
@@ -20,8 +21,6 @@ Frontend: Show a form with different field types
 
 Example Form with Input, Textarea, Select, Multiselect, Checkboxes, Radiobuttons, and Submit
 
-
-
 Frontend: Multistep Form
 ------------------------
 
@@ -30,8 +29,6 @@ Frontend: Multistep Form
 
 Example Multistep Form with clientside validation
 
-
-
 Backend: Mail Listing
 ---------------------
 
@@ -40,8 +37,6 @@ Backend: Mail Listing
 
 Manage the delivered mails with a fulltext search and some export possibilities
 
-
-
 Backend: Reporting
 ------------------
 
@@ -50,16 +45,9 @@ Backend: Reporting
 
 See the reporting about the delivered mails (Form or Marketing Data Analyses are possible)
 
-
-
-
-
 Documentation overview
 ======================
 
 *   `Introduction <https://github.com/in2code-de/powermail/blob/develop/Documentation/Readme.md>`__
-*   `Documentation for editors <https://github.com/in2code-de/powermail/blob/develop/Documentation/ForEditors/Readme.md>`__
-
-
-
 
+*   `Documentation for editors <https://github.com/in2code-de/powermail/blob/develop/Documentation/ForEditors/Readme.md>`__

tests/Integration/tests/directives/directive-raw-custom-sanitizer/expected/index.html

@@ -1,7 +1,11 @@
 <!-- content start -->
-<div class="section" id="directive-tests">
-    <h1>Directive tests</h1>
-    <p>Lorem Ipsum Dolor</p>
-    <p>Dolor sit!</p>
-</div>
+    <div class="section" id="directive-tests">
+            <h1>Directive tests</h1>
+
+
+  <p>Lorem Ipsum Dolor</p>
+
+  <p>Dolor sit!</p>
+
+    </div>
 <!-- content end -->

tests/Integration/tests/directives/directive-raw-default-sanitizer/expected/index.html

@@ -1,10 +1,11 @@
 <!-- content start -->
-<div class="section" id="directive-tests">
-    <h1>Directive tests</h1>
-    <div>
-        <p>Lorem Ipsum Dolor</p>
-        <h2>Some Rubric</h2>
-        <p>Dolor sit!</p>
-    </div>
+    <div class="section" id="directive-tests">
+            <h1>Directive tests</h1>
+            <div>
+
+  <p>Lorem Ipsum Dolor</p>
+  <h2>Some Rubric</h2>
+  <p>Dolor sit!</p>
 </div>
+    </div>
 <!-- content end -->

tests/Integration/tests/directives/directive-raw-no-sanitizer/expected/index.html

@@ -1,11 +1,11 @@
 <!-- content start -->
-<div class="section" id="directive-tests">
-    <h1>Directive tests</h1>
-    <div class="someClass">
-        <script>alert('XSS');</script>
-        <p>Lorem Ipsum Dolor</p>
-        <h2>Some Rubric</h2>
-        <p>Dolor sit!</p>
-    </div>
+    <div class="section" id="directive-tests">
+            <h1>Directive tests</h1>
+            <div class="someClass">
+  <script>alert('XSS');</script>
+  <p>Lorem Ipsum Dolor</p>
+  <h2>Some Rubric</h2>
+  <p>Dolor sit!</p>
 </div>
+    </div>
 <!-- content end -->