add include file sample and update readme and wiki

Author: vsch

.idea/compiler.xml

@@ -282,6 +282,8 @@ Progress
     - HTML blocks: all, non-comments, comments
   - Processor Extensions
     - Jekyll front matter
+    - Jekyll tag elements, with support for `{% include file %}`,
+      [Include Markdown and HTML content with Jekyll Tag Extension]
     - GitBook link URL encoding. Not applicable
     - HTML comment nodes: Block and Inline
     - Multi-line Image URLs
@@ -461,4 +463,5 @@ BSD (2-clause) licensed, see [LICENSE.txt] file.
 [sirthias]: https://github.com/sirthias
 [table.md]: https://github.com/vsch/idea-multimarkdown/blob/master/test/data/performance/table.md
 [vsch/pegdown]: https://github.com/vsch/pegdown/tree/develop
+[Include Markdown and HTML content with Jekyll Tag Extension]: ../../wiki/Usage#include-markdown-and-html-content-with-jekyll-tag-extension
 

.idea/markdown-exported-files.xml

@@ -70,9 +70,7 @@ flexmark-java
 - [0.1.0](#010)
 
 
-&nbsp;</details>
-
-&nbsp;<details id="version-history"><summary>**To Do**</summary>
+&nbsp;</details><details id="version-history"><summary>**To Do**</summary>
 
 ## To Do
 

README.md

@@ -36,7 +36,7 @@ <h3 id="block-macros">Block Macros</h3>
 <h3 id="inline-macros">Inline Macros:</h3>
 <p>A non-indenting space should be included before the opening and closing inline macro to prevent
 it from being interpreted as a block macro.</p>
-<p><img src="file:/Users/vlad/Library/Application Support/IdeaIC2017-1/idea-multimarkdown/emojis/information_source.png" alt="emoji symbols:information_source" height="20" width="20" align="absmiddle" /> Non-indenting space below is replaced with <code>․</code></p>
+<p><img src="file:/Users/vlad/Library/Application Support/IntelliJIdea2017.1/idea-multimarkdown/emojis/information_source.png" alt="emoji symbols:information_source" height="20" width="20" align="absmiddle" /> Non-indenting space below is replaced with <code>․</code></p>
 <pre><code class="markdown">․{{macroName attribute4='another format'}} 
 possibly containing other lines, but no blank lines 
 ․{{/macroName}}

VERSION.md

@@ -35,5 +35,9 @@
     <orderEntry type="module" module-name="flexmark-profile-pegdown" />
     <orderEntry type="module" module-name="flexmark-test-suite" />
     <orderEntry type="module" module-name="flexmark-youtrack-converter" />
+    <orderEntry type="module" module-name="flexmark-ext-ins" />
+    <orderEntry type="module" module-name="flexmark-ext-jekyll-tag" />
+    <orderEntry type="module" module-name="flexmark-ext-superscript" />
+    <orderEntry type="module" module-name="flexmark-ext-xwiki-macros" />
   </component>
 </module>

assets/images/flexmark-parsing.png

@@ -0,0 +1,111 @@
+package com.vladsch.flexmark.samples;
+
+import com.vladsch.flexmark.Extension;
+import com.vladsch.flexmark.ast.AutoLink;
+import com.vladsch.flexmark.ast.Document;
+import com.vladsch.flexmark.ast.Node;
+import com.vladsch.flexmark.ext.autolink.AutolinkExtension;
+import com.vladsch.flexmark.ext.jekyll.tag.JekyllTag;
+import com.vladsch.flexmark.ext.jekyll.tag.JekyllTagExtension;
+import com.vladsch.flexmark.html.AttributeProvider;
+import com.vladsch.flexmark.html.AttributeProviderFactory;
+import com.vladsch.flexmark.html.HtmlRenderer;
+import com.vladsch.flexmark.html.IndependentAttributeProviderFactory;
+import com.vladsch.flexmark.html.renderer.AttributablePart;
+import com.vladsch.flexmark.html.renderer.NodeRendererContext;
+import com.vladsch.flexmark.parser.Parser;
+import com.vladsch.flexmark.util.html.Attributes;
+import com.vladsch.flexmark.util.options.MutableDataHolder;
+import com.vladsch.flexmark.util.options.MutableDataSet;
+
+import java.io.File;
+import java.util.Arrays;
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+
+public class JekyllIncludeFileSample {
+    static String commonMark(String markdown, Map<String, String> included) {
+        MutableDataHolder options = new MutableDataSet();
+        options.set(Parser.EXTENSIONS, Arrays.asList(new Extension[] { AutolinkExtension.create(), JekyllTagExtension.create() }));
+
+        // change soft break to hard break
+        options.set(HtmlRenderer.SOFT_BREAK, "<br/>");
+
+        Parser parser = Parser.builder(options).build();
+        HtmlRenderer renderer = HtmlRenderer.builder(options).build();
+
+        Node document = parser.parse(markdown);
+
+        // see if document has includes
+        if (document instanceof Document) {
+            Document doc = (Document) document;
+            if (doc.contains(JekyllTagExtension.TAG_LIST)) {
+                List<JekyllTag> tagList = JekyllTagExtension.TAG_LIST.getFrom(doc);
+                Map<String, String> includeHtmlMap = new HashMap<String, String>();
+
+                for (JekyllTag tag : tagList) {
+                    String includeFile = tag.getParameters().toString();
+                    if (tag.getTag().equals("include") && !includeFile.isEmpty() && !includeHtmlMap.containsKey(includeFile)) {
+                        // see if it exists
+                        if (included.containsKey(includeFile)) {
+                            // have the file
+                            String text = included.get(includeFile);
+
+                            if (includeFile.endsWith(".md")) {
+                                Node includeDoc = parser.parse(text);
+                                String includeHtml = renderer.render(includeDoc);
+                                includeHtmlMap.put(includeFile, includeHtml);
+
+                                if (includeDoc instanceof Document) {
+                                    // copy any definition of reference elements from included file to our document
+                                    parser.transferReferences(doc, (Document) includeDoc);
+                                }
+                            } else {
+                                includeHtmlMap.put(includeFile, text);
+                            }
+                        }
+                    }
+
+                    if (!includeHtmlMap.isEmpty()) {
+                        doc.set(JekyllTagExtension.INCLUDED_HTML, includeHtmlMap);
+                    }
+                }
+            }
+        }
+
+        final String html = renderer.render(document);
+        return html;
+    }
+
+    public static void main(String[] args) {
+        Map<String, String> included = new HashMap<>();
+        included.put("test.md", "## Included Heading\n" +
+                "\n" +
+                "Included paragraph\n" +
+                "\n" +
+                "[ref]: http://example.com\n" +
+                "");
+
+        included.put("test.html", "<p>some text</p>\n" +
+                "");
+
+        String html = commonMark("http://github.com/vsch/flexmark-java\n" +
+                "\n" +
+                "[ref]\n" +
+                "\n" +
+                "{% include test.md %}\n" +
+                "\n" +
+                "", included);
+        System.out.println(html);
+
+        html = commonMark("http://github.com/vsch/flexmark-java\n" +
+                "\n" +
+                "[ref]\n" +
+                "\n" +
+                "{% include test.html %}\n" +
+                "\n" +
+                "", included);
+        System.out.println(html);
+    }
+}