Added new {% markdown %} twig tag

getgrav · Feb 22, 2018 · 8750602 · 8750602
1 parent 42d8836
commit 8750602
Show file tree

Hide file tree

Showing 5 changed files with 105 additions and 8 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,7 @@
     * Added `$grav['uri]->getCurrentUri()` method to get `Grav\Framework\Uri\Uri` instance for the current URL
     * Added `$grav['uri]->getCurrentRoute()` method to get `Grav\Framework\Route\Route` instance for the current URL
     * Added ability to have `php` version dependencies in GPM assets
+    * Added new `{% markdown %}` twig tag
 1. [](#improved)
     * Vendor library updated to latest  
     * Improved `Session` initialization

diff --git a/composer.lock b/composer.lock
diff --git a/system/src/Grav/Common/Twig/Node/TwigNodeMarkdown.php b/system/src/Grav/Common/Twig/Node/TwigNodeMarkdown.php
@@ -0,0 +1,35 @@
+<?php
+/**
+ * @package    Grav.Common.Twig
+ *
+ * @copyright  Copyright (C) 2015 - 2018 Trilby Media, LLC. All rights reserved.
+ * @license    MIT License; see LICENSE file for details.
+ */
+
+namespace Grav\Common\Twig\Node;
+
+class TwigNodeMarkdown extends \Twig_Node implements \Twig_NodeOutputInterface
+{
+    public function __construct(\Twig_Node $body, $lineno, $tag = 'markdown')
+    {
+        parent::__construct(array('body' => $body), array(), $lineno, $tag);
+    }
+    /**
+     * Compiles the node to PHP.
+     *
+     * @param \Twig_Compiler A Twig_Compiler instance
+     */
+    public function compile(\Twig_Compiler $compiler)
+    {
+        $compiler
+            ->addDebugInfo($this)
+            ->write('ob_start();' . PHP_EOL)
+            ->subcompile($this->getNode('body'))
+            ->write('$content = ob_get_clean();' . PHP_EOL)
+            ->write('preg_match("/^\s*/", $content, $matches);' . PHP_EOL)
+            ->write('$lines = explode("\n", $content);' . PHP_EOL)
+            ->write('$content = preg_replace(\'/^\' . $matches[0]. \'/\', "", $lines);' . PHP_EOL)
+            ->write('$content = join("\n", $content);' . PHP_EOL)
+            ->write('echo $this->env->getExtension(\'Grav\Common\Twig\TwigExtension\')->markdownFunction($content);' . PHP_EOL);
+    }
+}
diff --git a/system/src/Grav/Common/Twig/TokenParser/TwigTokenParserMarkdown.php b/system/src/Grav/Common/Twig/TokenParser/TwigTokenParserMarkdown.php
@@ -0,0 +1,53 @@
+<?php
+/**
+ * @package    Grav.Common.Twig
+ *
+ * @copyright  Copyright (C) 2015 - 2018 Trilby Media, LLC. All rights reserved.
+ * @license    MIT License; see LICENSE file for details.
+ */
+
+namespace Grav\Common\Twig\TokenParser;
+
+use Grav\Common\Twig\Node\TwigNodeMarkdown;
+
+/**
+ * Adds ability to inline markdown between tags.
+ *
+ * {% markdown %}
+ * This is **bold** and this _underlined_
+ *
+ * 1. This is a bullet list
+ * 2. This is another item in that same list
+ * {% endmarkdown %}
+ */
+class TwigTokenParserMarkdown extends \Twig_TokenParser
+{
+    /**
+     * {@inheritdoc}
+     */
+    public function parse(\Twig_Token $token)
+    {
+        $lineno = $token->getLine();
+        $this->parser->getStream()->expect(\Twig_Token::BLOCK_END_TYPE);
+        $body = $this->parser->subparse(array($this, 'decideMarkdownEnd'), true);
+        $this->parser->getStream()->expect(\Twig_Token::BLOCK_END_TYPE);
+        return new TwigNodeMarkdown($body, $lineno, $this->getTag());
+    }
+    /**
+     * Decide if current token marks end of Markdown block.
+     *
+     * @param \Twig_Token $token
+     * @return bool
+     */
+    public function decideMarkdownEnd(\Twig_Token $token)
+    {
+        return $token->test('endmarkdown');
+    }
+    /**
+     * {@inheritdoc}
+     */
+    public function getTag()
+    {
+        return 'markdown';
+    }
+}
diff --git a/system/src/Grav/Common/Twig/TwigExtension.php b/system/src/Grav/Common/Twig/TwigExtension.php
@@ -14,10 +14,10 @@
 use Grav\Common\Twig\TokenParser\TwigTokenParserScript;
 use Grav\Common\Twig\TokenParser\TwigTokenParserStyle;
 use Grav\Common\Twig\TokenParser\TwigTokenParserTryCatch;
+use Grav\Common\Twig\TokenParser\TwigTokenParserMarkdown;
 use Grav\Common\Utils;
 use Grav\Common\Markdown\Parsedown;
 use Grav\Common\Markdown\ParsedownExtra;
-use Grav\Common\Uri;
 use Grav\Common\Helpers\Base32;
 use RocketTheme\Toolbox\ResourceLocator\UniformResourceLocator;
 use Symfony\Component\Yaml\Yaml;
@@ -69,7 +69,7 @@ public function getFilters()
             new \Twig_SimpleFilter('fieldName', [$this, 'fieldNameFilter']),
             new \Twig_SimpleFilter('ksort', [$this, 'ksortFilter']),
             new \Twig_SimpleFilter('ltrim', [$this, 'ltrimFilter']),
-            new \Twig_SimpleFilter('markdown', [$this, 'markdownFilter']),
+            new \Twig_SimpleFilter('markdown', [$this, 'markdownFunction']),
             new \Twig_SimpleFilter('md5', [$this, 'md5Filter']),
             new \Twig_SimpleFilter('base32_encode', [$this, 'base32EncodeFilter']),
             new \Twig_SimpleFilter('base32_decode', [$this, 'base32DecodeFilter']),
@@ -157,6 +157,7 @@ public function getTokenParsers()
             new TwigTokenParserTryCatch(),
             new TwigTokenParserScript(),
             new TwigTokenParserStyle(),
+            new TwigTokenParserMarkdown(),
         ];
     }
 
@@ -543,7 +544,7 @@ public function absoluteUrlFilter($string)
      * @param bool $block  Block or Line processing
      * @return mixed|string
      */
-    public function markdownFilter($string, $block = true)
+    public function markdownFunction($string, $block = true)
     {
         $page     = $this->grav['page'];
         $defaults = $this->config->get('system.pages.markdown');