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
|
package org.jetbrains.dokka.gfm
import org.jetbrains.dokka.CoreExtensions
import org.jetbrains.dokka.base.DokkaBase
import org.jetbrains.dokka.base.renderers.DefaultRenderer
import org.jetbrains.dokka.base.renderers.PackageListCreator
import org.jetbrains.dokka.base.renderers.RootCreator
import org.jetbrains.dokka.base.resolvers.local.DefaultLocationProvider
import org.jetbrains.dokka.base.resolvers.local.LocationProviderFactory
import org.jetbrains.dokka.pages.*
import org.jetbrains.dokka.plugability.DokkaContext
import org.jetbrains.dokka.plugability.DokkaPlugin
import org.jetbrains.dokka.plugability.plugin
import org.jetbrains.dokka.plugability.query
import org.jetbrains.dokka.transformers.pages.PageTransformer
import java.lang.StringBuilder
class GfmPlugin : DokkaPlugin() {
val gfmPreprocessors by extensionPoint<PageTransformer>()
val renderer by extending {
CoreExtensions.renderer providing { CommonmarkRenderer(it) } applyIf { format == "gfm" }
}
val locationProvider by extending {
plugin<DokkaBase>().locationProviderFactory providing { MarkdownLocationProviderFactory(it) } applyIf { format == "gfm" }
}
val rootCreator by extending {
gfmPreprocessors with RootCreator
}
val packageListCreator by extending {
gfmPreprocessors providing {
PackageListCreator(
it,
"gfm",
"md"
)
} order { after(rootCreator) }
}
}
open class CommonmarkRenderer(
context: DokkaContext
) : DefaultRenderer<StringBuilder>(context) {
override val preprocessors = context.plugin<GfmPlugin>().query { gfmPreprocessors }
override fun StringBuilder.buildHeader(level: Int, content: StringBuilder.() -> Unit) {
buildParagraph()
append("#".repeat(level) + " ")
content()
buildNewLine()
}
override fun StringBuilder.buildLink(address: String, content: StringBuilder.() -> Unit) {
append("[")
content()
append("]($address)")
}
override fun StringBuilder.buildList(node: ContentList, pageContext: ContentPage, platformRestriction: PlatformData?) {
buildParagraph()
buildListLevel(node, pageContext)
buildParagraph()
}
private val indent = " ".repeat(4)
private fun StringBuilder.buildListItem(items: List<ContentNode>, pageContext: ContentPage, bullet: String = "*") {
items.forEach {
if (it is ContentList) {
val builder = StringBuilder()
builder.append(indent)
builder.buildListLevel(it, pageContext)
append(builder.toString().replace(Regex(" \n(?!$)"), " \n$indent"))
} else {
append("$bullet ")
it.build(this, pageContext)
buildNewLine()
}
}
}
private fun StringBuilder.buildListLevel(node: ContentList, pageContext: ContentPage) {
if (node.ordered) {
buildListItem(
node.children,
pageContext,
"${node.extra.allOfType<SimpleAttr>().find { it.extraKey == "start" }?.extraValue
?: 1.also { context.logger.error("No starting number specified for ordered list in node ${pageContext.dri.first()}!")}}."
)
} else {
buildListItem(node.children, pageContext, "*")
}
}
override fun StringBuilder.buildNewLine() {
append(" \n")
}
private fun StringBuilder.buildParagraph() {
append("\n\n")
}
override fun StringBuilder.buildPlatformDependent(content: PlatformHintedContent, pageContext: ContentPage) {
val distinct = content.platforms.map {
it to StringBuilder().apply {buildContentNode(content.inner, pageContext, it) }.toString()
}.groupBy(Pair<PlatformData, String>::second, Pair<PlatformData, String>::first)
if (distinct.size == 1)
append(distinct.keys.single())
else
distinct.forEach { text, platforms ->
append(platforms.joinToString(prefix = " [", postfix = "] $text") { it.name })
}
}
override fun StringBuilder.buildResource(node: ContentEmbeddedResource, pageContext: ContentPage) {
append("Resource")
}
override fun StringBuilder.buildTable(node: ContentTable, pageContext: ContentPage, platformRestriction: PlatformData?) {
buildParagraph()
val size = node.children.firstOrNull()?.children?.size ?: 0
if (node.header.size > 0) {
node.header.forEach {
it.children.forEach {
append("| ")
it.build(this, pageContext)
}
append("|\n")
}
} else {
append("| ".repeat(size))
if (size > 0) append("|\n")
}
append("|---".repeat(size))
if (size > 0) append("|\n")
node.children.forEach {
it.children.forEach {
append("| ")
it.build(this, pageContext)
}
append("|\n")
}
buildParagraph()
}
override fun StringBuilder.buildText(textNode: ContentText) {
val decorators = decorators(textNode.style)
append(decorators)
append(textNode.text.replace(Regex("[<>]"), ""))
append(decorators.reversed())
}
override fun StringBuilder.buildNavigation(page: PageNode) {
locationProvider.ancestors(page).asReversed().forEach { node ->
append("/")
if (node.isNavigable) buildLink(node, page)
else append(node.name)
}
buildParagraph()
}
override fun buildPage(page: ContentPage, content: (StringBuilder, ContentPage) -> Unit): String =
StringBuilder().apply {
content(this, page)
}.toString()
override fun buildError(node: ContentNode) {
context.logger.warn("Markdown renderer has encountered problem. The unmatched node is $node")
}
private fun decorators(styles: Set<Style>) = StringBuilder().apply {
styles.forEach {
when (it) {
TextStyle.Bold -> append("**")
TextStyle.Italic -> append("*")
TextStyle.Strong -> append("**")
TextStyle.Strikethrough -> append("~~")
else -> Unit
}
}
}.toString()
private val PageNode.isNavigable: Boolean
get() = this !is RendererSpecificPage || strategy != RenderingStrategy.DoNothing
private fun StringBuilder.buildLink(to: PageNode, from: PageNode) =
buildLink(locationProvider.resolve(to, from)) {
append(to.name)
}
override suspend fun renderPage(page: PageNode) {
val path by lazy { locationProvider.resolve(page, skipExtension = true) }
when (page) {
is ContentPage -> outputWriter.write(path, buildPage(page) { c, p -> buildPageContent(c, p) }, ".md")
is RendererSpecificPage -> when (val strategy = page.strategy) {
is RenderingStrategy.Copy -> outputWriter.writeResources(strategy.from, path)
is RenderingStrategy.Write -> outputWriter.write(path, strategy.text, "")
is RenderingStrategy.Callback -> outputWriter.write(path, strategy.instructions(this, page), ".md")
RenderingStrategy.DoNothing -> Unit
}
else -> throw AssertionError(
"Page ${page.name} cannot be rendered by renderer as it is not renderer specific nor contains content"
)
}
}
}
class MarkdownLocationProviderFactory(val context: DokkaContext) : LocationProviderFactory {
override fun getLocationProvider(pageNode: RootPageNode) = MarkdownLocationProvider(pageNode, context)
}
class MarkdownLocationProvider(
pageGraphRoot: RootPageNode,
dokkaContext: DokkaContext
) : DefaultLocationProvider(
pageGraphRoot,
dokkaContext
) {
override val extension = ".md"
}
|
