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
|
/*
* Copyright 2014-2023 JetBrains s.r.o. Use of this source code is governed by the Apache 2.0 license.
*/
package renderers.gfm
import org.jetbrains.dokka.gfm.renderer.CommonmarkRenderer
import org.jetbrains.dokka.links.DRI
import org.jetbrains.dokka.pages.ContentEmbeddedResource
import org.jetbrains.dokka.pages.ContentKind
import org.jetbrains.dokka.pages.DCI
import org.jetbrains.dokka.pages.TextStyle
import renderers.RawTestPage
import renderers.testPage
import kotlin.test.Test
import kotlin.test.assertEquals
class SimpleElementsTest : GfmRenderingOnlyTestBase() {
@Test
fun header() {
val page = testPage {
header(1, "The Hobbit or There and Back Again")
}
val expect = "//[testPage](test-page.md)\n\n# The Hobbit or There and Back Again"
CommonmarkRenderer(context).render(page)
assertEquals(expect, renderedContent)
}
@Test
fun link() {
val page = testPage {
link("They are not all accounted for, the lost Seeing Stones.", "http://www.google.com")
}
val expect =
"//[testPage](test-page.md)\n\n[They are not all accounted for, the lost Seeing Stones.](http://www.google.com)"
CommonmarkRenderer(context).render(page)
assertEquals(expect, renderedContent)
}
@Test
fun bold() {
val page = testPage {
text(
"That there’s some good in this world, Mr. Frodo… and it’s worth fighting for.",
styles = setOf(TextStyle.Bold)
)
}
val expect =
"//[testPage](test-page.md)\n\n**That there’s some good in this world, Mr. Frodo… and it’s worth fighting for.**"
CommonmarkRenderer(context).render(page)
assertEquals(expect, renderedContent)
}
@Test
fun italic() {
val page = testPage {
text("Even the smallest person can change the course of the future.", styles = setOf(TextStyle.Italic))
}
val expect = "//[testPage](test-page.md)\n\n*Even the smallest person can change the course of the future.*"
CommonmarkRenderer(context).render(page)
assertEquals(expect, renderedContent)
}
@Test
fun italicAndBold() {
val page = testPage {
text(
"There is no curse in Elvish, Entish, or the tongues of Men for this treachery.",
styles = setOf(TextStyle.Bold, TextStyle.Italic)
)
}
val expect =
"//[testPage](test-page.md)\n\n***There is no curse in Elvish, Entish, or the tongues of Men for this treachery.***"
CommonmarkRenderer(context).render(page)
assertEquals(expect, renderedContent)
}
@Test
fun strikethrough() {
val page = testPage {
text(
"A day may come when the courage of men fails… but it is not THIS day",
styles = setOf(TextStyle.Strikethrough)
)
}
val expect =
"//[testPage](test-page.md)\n\n~~A day may come when the courage of men fails… but it is not THIS day~~"
CommonmarkRenderer(context).render(page)
assertEquals(expect, renderedContent)
}
@Test
fun images() {
val image = ContentEmbeddedResource(
children = emptyList(),
address = "https://www.google.pl/images/branding/googlelogo/1x/googlelogo_color_272x92dp.png",
altText = "This is a google logo",
dci = DCI(setOf(DRI.topLevel), ContentKind.Main),
sourceSets = emptySet()
)
val page = RawTestPage(content = image)
val expect =
"//[testPage](test-page.md)\n\n"
CommonmarkRenderer(context).render(page)
assertEquals(expect, renderedContent)
}
@Test
fun simpleTableWithHeader() {
val page = testPage {
table {
header {
text("Col1")
text("Col2")
text("Col3")
}
row {
text("Text1")
text("Text2")
text("Text3")
}
row {
text("Text4")
text("Text5")
text("Text6")
}
}
}
val expect = """|//[testPage](test-page.md)
|
|| Col1 | Col2 | Col3 |
||---|---|---|
|| Text1 | Text2 | Text3 |
|| Text4 | Text5 | Text6 |""".trimMargin()
CommonmarkRenderer(context).render(page)
assertEquals(expect, renderedContent)
}
@Test
fun simpleTableWithoutHeader() {
val page = testPage {
table {
row {
text("Text1")
text("Text2")
text("Text3")
}
row {
text("Text4")
text("Text5")
text("Text6")
}
}
}
val expect = """|//[testPage](test-page.md)
|
|| | | |
||---|---|---|
|| Text1 | Text2 | Text3 |
|| Text4 | Text5 | Text6 |""".trimMargin()
CommonmarkRenderer(context).render(page)
assertEquals(expect, renderedContent)
}
@Test
fun `table with extra cell in row`() {
val page = testPage {
table {
header {
text("Col1")
}
row {
text("Text1")
text("Text2")
}
}
}
val expect = """|//[testPage](test-page.md)
|
|| Col1 |
||---|
|| Text1 | Text2 |""".trimMargin()
CommonmarkRenderer(context).render(page)
assertEquals(expect, renderedContent)
}
@Test
fun `table with extra cell in header`() {
val page = testPage {
table {
header {
text("Col1")
text("Col2")
}
row {
text("Text1")
}
}
}
val expect = """|//[testPage](test-page.md)
|
|| Col1 | Col2 |
||---|---|
|| Text1 |""".trimMargin()
CommonmarkRenderer(context).render(page)
assertEquals(expect, renderedContent)
}
@Test
fun escapeText() {
val page = testPage {
text(
"<b>a</b>",
)
}
val expect =
"//[testPage](test-page.md)\n\n<b>a</b>"
CommonmarkRenderer(context).render(page)
assertEquals(expect, renderedContent)
}
@Test
fun `unordered list with two items`() {
val page = testPage {
unorderedList {
item { text("Item 1") }
item { text("Item 2") }
}
}
val expect = """|//[testPage](test-page.md)
|
|- Item 1
|- Item 2""".trimMargin()
CommonmarkRenderer(context).render(page)
assertEquals(expect, renderedContent)
}
@Test
fun `unordered list with styled text`() {
val page = testPage {
unorderedList {
item {
text("Nobody", styles = setOf(TextStyle.Italic))
text(" tosses a Dwarf!")
}
}
}
val expect = "//[testPage](test-page.md)\n\n- *Nobody* tosses a Dwarf!"
CommonmarkRenderer(context).render(page)
assertEquals(expect, renderedContent)
}
@Test
fun `ordered list with two items`() {
val page = testPage {
orderedList {
item { text("Item 1") }
item { text("Item 2") }
}
}
val expect = """|//[testPage](test-page.md)
|
|1. Item 1
|2. Item 2""".trimMargin()
CommonmarkRenderer(context).render(page)
assertEquals(expect, renderedContent)
}
@Test
fun `ordered list with nested unordered list`() {
val page = testPage {
orderedList {
item {
text("And another list:")
unorderedList {
item { text("Item 1") }
item { text("Item 2") }
}
}
item { text("Following item") }
}
}
val expect = """|//[testPage](test-page.md)
|
|1. And another list:
|
| - Item 1
| - Item 2
|2. Following item""".trimMargin()
CommonmarkRenderer(context).render(page)
assertEquals(expect, renderedContent)
}
@Test
fun `ordered list with nested table`() {
val page = testPage {
orderedList {
item {
text("The following table is nested in a list:")
table {
header {
text("Col1")
text("Col2")
}
row {
text("Text1")
text("Text2")
}
}
}
}
}
val expect = """|//[testPage](test-page.md)
|
|1. The following table is nested in a list:
| | Col1 | Col2 |
| |---|---|
| | Text1 | Text2 |""".trimMargin()
CommonmarkRenderer(context).render(page)
assertEquals(expect, renderedContent)
}
@Test
fun `three levels of list`() {
val page = testPage {
unorderedList {
item {
text("Level 1")
unorderedList {
item {
text("Level 2")
unorderedList {
item {
text("Level 3")
}
}
}
}
}
}
}
// Extra newlines are not pretty but do not impact formatting
val expect = """|//[testPage](test-page.md)
|
|- Level 1
|
| - Level 2
|
| - Level 3""".trimMargin()
CommonmarkRenderer(context).render(page)
assertEquals(expect, renderedContent)
}
@Test
fun `nested list with no text preceding it`() {
val page = testPage {
unorderedList {
item {
unorderedList {
item {
text("Nested")
}
}
}
}
}
val expect = """|//[testPage](test-page.md)
|
|-
| - Nested""".trimMargin()
CommonmarkRenderer(context).render(page)
assertEquals(expect, renderedContent)
}
}
|
