summaryrefslogtreecommitdiff
path: root/GEMTEXT-COMPATIBILITY-REFERENCE-GUIDE.md
blob: 91f289688fa932f8db57794ffbf48a04c9dbefe463db49dff36cf2e255e08c56 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
# Gemtext Compatibility Reference Guide

This reference guide documents the compatibility of Markdown features with gemtext as an output format of this Hugo theme. It should be assumed that any Markdown features not documented below are unsupported.

The reference guide format is as follows:

```markdown
## <Feature Name>

<Markdown input> => <gemtext output>

Support level: <full, partial, or unsupported>

[Other relevant information]

[Examples]
```

## Nesting

```plaintext
nested element => unchanged
```

Support level: unsupported

Nesting support is not factored into other features' support levels.

## Escape Characters

```plaintext
literal backslash + character => unchanged
```

Support level: unsupported

Escape character support is not factored into other features' support levels.

## Paragraphs

```plaintext
paragraph => text line
```

Support level: full

E.g:

Markdown input:

```markdown
I will become a text line in the gemtext output.
```

Gemtext output:

```gemtext
I will become a text line in the gemtext output.
```

## Blockquotes

```plaintext
blockquote => quote line
```

Support level: full

E.g:

Markdown input:

```markdown
> I will become quote lines
> in the gemtext output.
```

Gemtext output:

```gemtext
> I will become quote lines
> in the gemtext output.
```

## Headings

```plaintext
heading => (flattened) heading
```

Support level: partial

Number signs, equal signs, and dashes can delimit headings. Markdown heading levels greater than level 3 are flattened to level 3 in the gemtext output. The use of heading levels greater than level 3 is strongly discouraged.

E.g:

Markdown input:

```markdown
===
I will become a level 1 heading in the gemtext output


---------
I will become a level 2 heading in the gemtext output


### I will become a level 3 heading in the gemtext output


#### I will become a level 3 heading in the gemtext output


##### I will become a level 3 heading in the gemtext output


###### I will become a level 3 heading in the gemtext output
```

Gemtext output:

```gemtext
# I will become a level 1 heading in the gemtext output


## I will become a level 2 heading in the gemtext output


### I will become a level 3 heading in the gemtext output


### I will become a level 3 heading in the gemtext output


### I will become a level 3 heading in the gemtext output


### I will become a level 3 heading in the gemtext output
```

## Emphasis (Italic)

```plaintext
emphasis (italic) => text with italic delimiters removed
```

Support level: partial

Asterisks delimiting italicized text are removed from the gemtext output.

E.g:

Markdown input:

```markdown
I will become *italicized* in the HTML output.
```

Gemtext output:

```gemtext
I will become italicized in the HTML output.
```

## Emphasis (Bold)

```plaintext
emphasis (bold) => text with bold delimiters removed
```

Support level: partial

Asterisks delimiting bolded text are removed from the gemtext output.

E.g:

Markdown input:

```markdown
I will become **bolded** in the HTML output.
```

Gemtext output:

```gemtext
I will become bolded in the HTML output.
```

## Emphasis (Bold and Italic)

```plaintext
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.

E.g:

Markdown input:

```markdown
I will become ***bolded and italicized*** in the HTML output.
```

Gemtext output:

```gemtext
I will become bolded and italicized in the HTML output.
```

## Unordered Lists

```plaintext
unordered list item => unordered list item
```

Support level: full

Dashes \(\-\), asterisks \(\*\), and plus signs \(\+\) can delimit unordered list items.

E.g:

Markdown input:

```markdown
* I will become unordered list #1 item #1 in the gemtext output
* I will become unordered list #1 item #2 in the gemtext output

- I will become unordered list #2 item #1 in the gemtext output
- I will become unordered list #2 item #2 in the gemtext output

+ I will become unordered list #3 item #1 in the gemtext output
+ I will become unordered list #3 item #2 in the gemtext output
```

Gemtext output:

```markdown
* I will become unordered list #1 item #1 in the gemtext output
* I will become unordered list #1 item #2 in the gemtext output

* I will become unordered list #2 item #1 in the gemtext output
* I will become unordered list #2 item #2 in the gemtext output

* I will become unordered list #3 item #1 in the gemtext output
* I will become unordered list #3 item #2 in the gemtext output
```

## Ordered Lists

```plaintext
ordered list item => unordered list line
```

Support level: partial

Numbers can delimit unordered list lines.

E.g:

Markdown input:

```markdown
1. I will become an unordered list line in the gemtext output
2. I will also become an unordered list line in the gemtext output
```

Gemtext output:

```gemtext
* I will become an unordered list line in the gemtext output
* I will also become an unordered list line in the gemtext output
```

## Preformatted Text

```plaintext
preformatted text => preformatting toggle lines + preformatted text lines
```

Support level: partial

Only 3 consecutive backticks can delimit preformatted text. Text following the leading "```" on the same line is permitted.

E.g:

Markdown input:

````markdown
```markdown
[this link](https://example.com) will not be rendered in the HTML nor in the gemtext output.
```
````

Gemtext output:

````gemtext
```markdown
[this link](https://example.com) will not be rendered in the HTML nor in the gemtext output.
```
````

## Links

```plaintext
link => superscripted reference numbers + link lines
```

Support level: partial

Hypertext references must be URL-encoded. Angle bracketed URLs, Markdown reference-style links, and linking to heading IDs are unsupported.

If the "makerefs" variable in the frontmatter is set to true (the default), text enclosed in brackets \(e.g. \[Arch Linux\]\) immediately followed by a URL in parenthesis \(e.g. \(https://archlinux.org\)\) and an optional link title \("Arch Linux"\) becomes a reference-style link with a corresponding link line appended to the bottom of the page in the gemtext output. If there is a link title in the Markdown, it becomes the link name in the gemtext.

E.g:

Markdown input:

```markdown
[Debian](https://www.debian.org) is a good OS, but I prefer [arch](https://archlinux.org "Arch Linux").
```
 
Gemtext output:

```gemtext
Debian¹ is a good OS, but I prefer arch².


## References

=> https://www.debian.org 🔗 [1]: Debian
=> https://archlinux.org 🔗 [2]: Arch Linux
```

If the "makerefs" variable in the frontmatter is set to false, reference-style links are not created and only links that occupy the entire line become link lines in the gemtext output.

E.g:

Markdown input:

```markdown
---
<mandatory frontmatter>
makerefs: false
---
[Puppy Linux](https://puppylinux-woof-ce.github.io "a lightweight linux distro")
```

Gemtext output:

```gemtext
=> https://puppylinux-woof-ce.github.io Puppy Linux
```

## Inline Images

```plaintext
inline image => link line
```

Support level: partial

Links with a preceding exclamation mark are treated the same as normal links in the gemtext output.

E.g:

Markdown input:

```markdown
---
<mandatory frontmatter>
makerefs: false
---
Check out my dog:

![Spot](pics/dogs/spot.jpeg "A black, brown, and white hound running in the yard with his tongue out")
```

Gemtext output:

```gemtext
Check out my dog:

=> pics/dogs/spot.jpeg Spot
```

## Whitespace

```plaintext
whitespace => literal whitespace
```

Support level: partial

Whitespace in the Markdown input is copied verbatim into the gemtext output. For maximum compatibility, it is advised to use 2 literal newlines after each element except before headings. Headings require 3 preceding literal newlines except at the start of the document.

E.g:

Markdown input:

```markdown
I will become a text line


## I will become a level 2 heading

* I will become unordered list item #1
* I will become unordered list item #2

> I will become
> quote lines
```

Gemtext output:

```gemtext
I will become a text line


## I will become a level 2 heading

* I will become unordered list item #1
* I will become unordered list item #2

> I will become
> quote lines
```