From a4bf3d331ac4b5929d74dd6dbce092f1406003fe4e5f6a89f4c52ce8f8162e34 Mon Sep 17 00:00:00 2001 From: Nicholas Johnson Date: Thu, 1 Jun 2023 00:00:00 +0000 Subject: Update documentation --- GEMTEXT-COMPATIBILITY.md | 26 ++++++++++++++------------ 1 file changed, 14 insertions(+), 12 deletions(-) (limited to 'GEMTEXT-COMPATIBILITY.md') diff --git a/GEMTEXT-COMPATIBILITY.md b/GEMTEXT-COMPATIBILITY.md index 3e206a4..2d4e7b3 100644 --- a/GEMTEXT-COMPATIBILITY.md +++ b/GEMTEXT-COMPATIBILITY.md @@ -45,27 +45,29 @@ Newlines are partially supported. Line breaks are unsupported. Explanation: -The gemtext renderer and HTML renderer handle whitespace differently. While whitespace has special meaning in Markdown, the gemtext renderer simply copies it unmodified into the output. It is possible to achieve consecutive newlines in the HTML, but the gemtext won't render it correctly. For compatibility, use exactly two literal newlines except after headings. After headings, just use one newline. +The gemtext renderer and HTML renderer handle whitespace differently. While whitespace has special meaning in Markdown, the gemtext renderer simply copies it unmodified into the output. It is possible to achieve consecutive newlines in the HTML, but the gemtext won't render it correctly. For compatibility, use two literal newlines after each new element except before headings. Headings must be preceded by three literal newlines. E.g: -```markdown -Do +````markdown +I am a paragraph. -this -``` +* unordered list item 1 +* unordered list item 2 -```markdown -Don't do -this -``` +1. ordered list item 1 +2. ordered list item 2 -```markdown -Don't do +## I am a Heading -this ``` +I am preformatted text. +``` + +> I am +> a quote +```` ## Emphasis -- cgit v1.2.3