- Non One Start Item
- numbered item : definition item
1 Numbered Heading 1
1.1 Numbered Heading 1.1
2 Numbered Heading 2
2.1 Numbered Heading 2.1
``` -------------------------------- ### Parsing Headings and TOC (flexmark-java) Source: https://github.com/vsch/flexmark-java/blob/master/flexmark-formatter-test-suite/src/test/resources/formatter_issue_test_suite_spec.md This example illustrates flexmark-java's ability to parse various heading levels and a Table of Contents (TOC) definition. It shows how headings are rendered and how a TOC placeholder is handled, demonstrating basic structural parsing. ```Markdown ## Header 2 ### Header 3 ### What you didn't know you were missing [TOC]: # "" ### title"s - [Header 2](#header-2) - [Header 3](#header-3) ``` ```Text ## Header 2 ### Header 3 ``` -------------------------------- ### Non-Definition: Bullet List Item with Colon - Example 2 Source: https://github.com/vsch/flexmark-java/blob/master/flexmark-ext-definition/src/test/resources/ext_definition_ast_spec.md Shows that a line starting with a colon, when part of a bullet list item, is treated as content within that list item, not as a definition. The HTML output confirms it remains within the- bullet item : definition item
- Non One Start Item
~~foo
`, and the AST, confirming the `~~` are treated as literal text due to the unclosed tag. ```CommonMark ~~foo ``` ```HTML~~foo
``` ```AST Document[0, 5] Paragraph[0, 5] Text[0, 5] chars:[0, 5, "~~foo"] ``` -------------------------------- ### Definition List Example 1 - Markdown Source: https://github.com/vsch/flexmark-java/blob/master/flexmark-ext-definition/src/test/resources/ext_definition_formatter_spec.md An example showing a definition item without a preceding term, which might not render as a standard definition list or could be part of a larger context. ```Markdown : definition item . : definition item ``` -------------------------------- ### Wrap Functionality Example 2 - Margin with Tracked Offset Source: https://github.com/vsch/flexmark-java/blob/master/flexmark-core-test/src/test/resources/core_paragraph_formatter_spec.md This example demonstrates the 'Wrap' functionality with a margin of 66, showing the effect of a tracked offset (indicated by ⦙) on the wrapping behavior. It illustrates how repeated prefixes in items are automatically copied when adding or splitting an item. ```Text Add: configuration for repeated prefixes in items, which would `be #2` ⦙copied when adding/splitting an item. In other words they would be treated equivalent to task item marker prefix. That way standard: `Add: `, `Fix: `, `Break: ` and `Deprecate: ` prefixes would be automatically copied. ``` -------------------------------- ### GFM Task List Markdown Input - Example 19 Source: https://github.com/vsch/flexmark-java/blob/master/flexmark-ext-gfm-tasklist/src/test/resources/ext_gfm_tasklist_ast_spec.md Demonstrates basic GitHub Flavored Markdown (GFM) task list syntax, including both standard list items and task list items, with consistent indentation. This input is processed by flexmark-java to generate HTML and an AST. ```Markdown - task - [ ] task 1. task 1. [ ] task ``` -------------------------------- ### Escaping Pipe Characters in Markdown with Flexmark-Java Source: https://github.com/vsch/flexmark-java/blob/master/flexmark-formatter-test-suite/src/test/resources/formatter_issue_test_suite_spec.md This snippet demonstrates how a pipe character ('|') needs to be escaped when it appears at the start of a wrapped line in Markdown, especially when 'aside' is enabled, to prevent misinterpretation during parsing. ```Markdown Text wrapping pipe `|` should be escaped when | is wrapped to start of line. ``` -------------------------------- ### Autolink WWW URLs (Issue #178) - Markdown Source: https://github.com/vsch/flexmark-java/blob/master/flexmark-ext-autolink/src/test/resources/ext_autolink_ast_spec.md This example addresses Issue #178, demonstrating that the AutolinkExtension correctly adds the `http://` prefix to simple URLs starting with `www.` when converting them into hyperlinks. ```Markdown auto link www.example.com ``` -------------------------------- ### Separating Aside Blocks with a Blank Line (Markdown) Source: https://github.com/vsch/flexmark-java/blob/master/flexmark-ext-aside/src/test/resources/ext_aside_ast_spec.md This example demonstrates that a blank line between two lines starting with the Aside marker `|` will cause them to be parsed as two distinct Aside blocks, each containing its own paragraph. ```Markdown | foo\n\n| bar\n ``` -------------------------------- ### Basic Markdown Parsing and HTML Rendering in Java Source: https://github.com/vsch/flexmark-java/blob/master/README.md This Java code demonstrates the fundamental usage of flexmark-java to parse a Markdown string and render it as HTML. It initializes a `Parser` and `HtmlRenderer` with default options, parses the input, and prints the resulting HTML. Optional extensions and soft-break handling are commented out as examples. ```Java package com.vladsch.flexmark.samples; import com.vladsch.flexmark.util.ast.Node; import com.vladsch.flexmark.html.HtmlRenderer; import com.vladsch.flexmark.parser.Parser; import com.vladsch.flexmark.util.data.MutableDataSet; public class BasicSample { public static void main(String[] args) { MutableDataSet options = new MutableDataSet(); // uncomment to set optional extensions //options.set(Parser.EXTENSIONS, Arrays.asList(TablesExtension.create(), StrikethroughExtension.create())); // uncomment to convert soft-breaks to hard breaks //options.set(HtmlRenderer.SOFT_BREAK, "\n"); Parser parser = Parser.builder(options).build(); HtmlRenderer renderer = HtmlRenderer.builder(options).build(); // You can re-use parser and renderer instances Node document = parser.parse("This is *Sparta*"); String html = renderer.render(document); // "
This is Sparta
\n" System.out.println(html); } } ``` -------------------------------- ### Markdown Syntax Demonstration with HTML Output Source: https://github.com/vsch/flexmark-java/blob/master/flexmark-profile-pegdown/src/test/resources/pegdown_profile_compatibility_spec.md This example showcases a comprehensive set of Markdown features, including headings, thematic breaks, paragraphs with lazy continuation, nested lists (bullet and numbered), blockquotes, and both fenced and indented code blocks. It provides the original Markdown input and its corresponding HTML rendering, demonstrating how flexmark-java processes these elements. ```Markdown #Heading ----- paragraph text lazy continuation * list item > block quote lazy continuation ~~~info with uneven indent with uneven indent indented code ~~~ with uneven indent with uneven indent indented code 1. numbered item 1 1. numbered item 2 1. numbered item 3 - bullet item 1 - bullet item 2 - bullet item 3 1. numbered sub-item 1 1. numbered sub-item 2 1. numbered sub-item 3 ~~~info with uneven indent with uneven indent indented code ~~~ with uneven indent with uneven indent indented code ``` ```HTMLHeading
paragraph text lazy continuation
- list item
block quote lazy continuation
with uneven indent
with uneven indent
indented code
with uneven indent
with uneven indent
indented code
- numbered item 1
- numbered item 2
- numbered item 3
- bullet item 1
- bullet item 2
- bullet item 3
- numbered sub-item 1
- numbered sub-item 2
- numbered sub-item 3
with uneven indent with uneven indent indented codewith uneven indent with uneven indent indented code
0.1. Numbered Heading 0.1
1. Numbered Heading 1
1.1. Numbered Heading 1.1
2. Numbered Heading 2
2.1. Numbered Heading 2.1
``` -------------------------------- ### Installing TypeScript as a Dev Dependency (Shell) Source: https://github.com/vsch/flexmark-java/blob/master/flexmark-profile-pegdown/src/test/resources/issue_mn_236_exception_spec.md Installs the TypeScript compiler as a development dependency for the current project. This ensures the project has its own version of TypeScript available for compilation. ```Shell npm install --save-dev typescript ``` -------------------------------- ### Rendering Ordered Lists with First Item Reset in Markdown Source: https://github.com/vsch/flexmark-java/blob/master/flexmark-core-test/src/test/resources/core_formatter_spec.md This example demonstrates the `list-reset-first-item` option, which forces the first item of any ordered list to start at 1, and subsequent items are renumbered sequentially. Nested lists also reset their first item. ```Markdown 2. item 1 3. item 2 4. item 2.1 1. item 2.2 ``` ```Markdown 1. item 1 2. item 2 1. item 2.1 2. item 2.2 ``` -------------------------------- ### Prioritized Task List (Low Priority) - Example 20 (Markdown/Task List) Source: https://github.com/vsch/flexmark-java/blob/master/flexmark-ext-gfm-tasklist/src/test/resources/ext_gfm_tasklist_formatter_spec.md This snippet continues the demonstration of a 'low' priority task list, focusing on detailed caret offset tracking within the task items and regular list items. It shows how specific characters and prefixes are tracked. ```Markdown/Task List * item ⦙1⦙.⦙ ⦙[⦙ ⦙]⦙ ⦙Add1:⦙ ⦙*⦙ ⦙Add2:⦙ * [ ] Add3: * [ ] Fix: + [ ] do not ``` -------------------------------- ### Generating Ordered TOC with Missing First Level Heading (No Spacer) Source: https://github.com/vsch/flexmark-java/blob/master/flexmark-ext-toc/src/test/resources/ext_simtoc_formatter_markdown_spec.md This example illustrates generating an ordered Table of Contents when the document starts with a heading level other than 1. It shows how the `[TOC levels=1-6]:#` directive handles the hierarchy when the top-level heading is absent. ```Markdown [TOC levels=1-6]:# ## Header 1 # Header 2 ### Header 3 ## Header 4 # Header 5 . [TOC levels=1-6]: # ``` -------------------------------- ### Adding Source Position Attributes to HTML Elements Source: https://github.com/vsch/flexmark-java/blob/master/flexmark-ext-gitlab/src/test/resources/ext_gitlab_ast_spec.md This example shows how the 'src-pos' option adds 'md-pos' attributes to generated HTML elements, indicating their original character start and end positions in the Markdown source. This is useful for debugging or linking back to source. ```markdown >>> Block Quote Contents >>> Nested Block Quote Contents >>> >>> ``` ```htmlBlock Quote Contents
Nested Block Quote Contents
``` -------------------------------- ### Handling HTML Blocks in Formatter Source: https://github.com/vsch/flexmark-java/blob/master/flexmark-core-test/src/test/resources/core_translation_formatter_spec.md This example illustrates how the formatter processes HTML block elements. It shows that the content within the HTML tags is translated, but the HTML tags themselves are preserved, demonstrating partial translation within HTML structures. ```HTML this is a test ``` -------------------------------- ### Markdown Loose Item Handling: Example 9 Source: https://github.com/vsch/flexmark-java/blob/master/flexmark-profile-pegdown/src/test/resources/pegdown_profile_compatibility_spec.md This example demonstrates Markdown list rendering, focusing on how blank lines between list items affect their 'tightness' or 'looseness' in the generated HTML. It provides the Markdown input and the corresponding HTML output. ```Markdown - item 1 - item 1.1 - item 2 - item 2.1 - item 3 - item 3.1 - item 4 - item 4.1 ``` ```HTML
- item 1
- item 1.1
- item 2
- item 2.1
- item 3
- item 3.1
- item 4
- item 4.1
tags within
- Definition Term
Loose Definition of above term
- Tight definition of above term
Another loose definition term
block quoted text lazy continuation
another paragraph
``` ```AST Document[0, 56] BlockQuote[0, 38] marker:[0, 1, ">"] Paragraph[2, 38] isTrailingBlankLine Text[2, 19] chars:[2, 19, "block … text"] SoftLineBreak[19, 20] Text[20, 37] chars:[20, 37, "lazy … ation"] Paragraph[39, 56] Text[39, 56] chars:[39, 56, "anoth … graph"] ``` -------------------------------- ### Enabling Source Position Attributes in HTML Source: https://github.com/vsch/flexmark-java/blob/master/flexmark-ext-typographic/src/test/resources/ext_typographic_ast_spec.md This example shows how to enable the `src-pos` option to include source position attributes in the generated HTML. The `md-pos` attribute on HTML elements indicates the start and end character offsets from the original Markdown source, useful for debugging or linking back to source. ```Markdown Sample with l'existence, from 1...2 and so on. . . en--dash and em---dash ``` ```HTMLSample with l’existence, from 1…2 and so on…
en–dash and em—dash
``` -------------------------------- ### Rendering Task List with Heading (Issue #136, Example 2) Source: https://github.com/vsch/flexmark-java/blob/master/flexmark-profile-pegdown/src/test/resources/pegdown_extension_compatibility_spec.md This example demonstrates the rendering of a Markdown task list preceded by a heading. It verifies that flexmark-java correctly processes the task list syntax into an HTML unordered list with interactive checkboxes, maintaining the heading structure. ```Markdown # Task List - [x] Task 1 - [ ] Task 2 - [x] Task 3 ``` ```HTMLTask List
- Task 1
- Task 2
- Task 3