summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNicholas Johnson <nick@nicholasjohnson.ch>2024-05-02 00:00:00 +0000
committerNicholas Johnson <nick@nicholasjohnson.ch>2024-05-02 00:00:00 +0000
commita8bda0a1554b3255c67ea39c609532ae87f7105cde5d854d0b52e175484b0b1a (patch)
treec33355aea35307e435de0bc09f2fc86a71b4bc4339fbf5712e95a2152e6860cd
parent1575b09797c66dc4a9cc1a9f1d367832531bf1340ab49aaa6b2928058ab8b410 (diff)
Document unexpected behaviorHEADv1.2.6master
-rw-r--r--GEMTEXT-COMPATIBILITY-REFERENCE-GUIDE.md18
1 files changed, 15 insertions, 3 deletions
diff --git a/GEMTEXT-COMPATIBILITY-REFERENCE-GUIDE.md b/GEMTEXT-COMPATIBILITY-REFERENCE-GUIDE.md
index 91f2896..7aad7a0 100644
--- a/GEMTEXT-COMPATIBILITY-REFERENCE-GUIDE.md
+++ b/GEMTEXT-COMPATIBILITY-REFERENCE-GUIDE.md
@@ -146,7 +146,7 @@ emphasis (italic) => text with italic delimiters removed
Support level: partial
-Asterisks delimiting italicized text are removed from the gemtext output.
+Asterisks delimiting italicized text are removed from the gemtext output. Using italics with other supported Markdown features can cause unexpected behavior.
E.g:
@@ -154,12 +154,16 @@ Markdown input:
```markdown
I will become *italicized* in the HTML output.
+
+*##* I will become a level 2 heading in the gemtext output but not in the HTML output
```
Gemtext output:
```gemtext
I will become italicized in the HTML output.
+
+## I will become a level 2 heading in the gemtext output but not in the HTML output
```
## Emphasis (Bold)
@@ -170,7 +174,7 @@ emphasis (bold) => text with bold delimiters removed
Support level: partial
-Asterisks delimiting bolded text are removed from the gemtext output.
+Asterisks delimiting bolded text are removed from the gemtext output. Using bolding with other supported Markdown features can cause unexpected behavior.
E.g:
@@ -178,12 +182,16 @@ Markdown input:
```markdown
I will become **bolded** in the HTML output.
+
+**##** I will become a level 2 heading in the gemtext output but not in the HTML output
```
Gemtext output:
```gemtext
I will become bolded in the HTML output.
+
+## I will become a level 2 heading in the gemtext output but not in the HTML output
```
## Emphasis (Bold and Italic)
@@ -194,7 +202,7 @@ emphasis (bold and italic) => text with bold and italic delimiters removed
Support level: partial
-Asterisks delimiting bolded and italicized text are removed from the gemtext output.
+Asterisks delimiting bolded and italicized text are removed from the gemtext output. Using bolding and italics with other supported Markdown features can cause unexpected behavior.
E.g:
@@ -202,12 +210,16 @@ Markdown input:
```markdown
I will become ***bolded and italicized*** in the HTML output.
+
+***##*** I will become a level 2 heading in the gemtext output but not in the HTML output
```
Gemtext output:
```gemtext
I will become bolded and italicized in the HTML output.
+
+## I will become a level 2 heading in the gemtext output but not in the HTML output
```
## Unordered Lists