aboutsummaryrefslogtreecommitdiff
path: root/plugins/jekyll
diff options
context:
space:
mode:
authorAndrzej Ratajczak <andrzej.ratajczak98@gmail.com>2020-03-31 13:33:31 +0200
committerPaweł Marks <Kordyjan@users.noreply.github.com>2020-04-01 11:02:45 +0200
commit10e8dc85946aabf797d73552e0bc98330764ba3f (patch)
tree7175ae51e36f5816f5de4df2842255b77d91e34f /plugins/jekyll
parentd9af94f2b26d54c88fb0696560de166af9df3d65 (diff)
downloaddokka-10e8dc85946aabf797d73552e0bc98330764ba3f.tar.gz
dokka-10e8dc85946aabf797d73552e0bc98330764ba3f.tar.bz2
dokka-10e8dc85946aabf797d73552e0bc98330764ba3f.zip
Fixes problems with Markdown and Jekyll
Diffstat (limited to 'plugins/jekyll')
-rw-r--r--plugins/jekyll/build.gradle.kts7
-rw-r--r--plugins/jekyll/src/main/kotlin/JekyllPlugin.kt158
2 files changed, 9 insertions, 156 deletions
diff --git a/plugins/jekyll/build.gradle.kts b/plugins/jekyll/build.gradle.kts
index 535a0aef..03fcfc58 100644
--- a/plugins/jekyll/build.gradle.kts
+++ b/plugins/jekyll/build.gradle.kts
@@ -1,8 +1,13 @@
publishing {
publications {
- register<MavenPublication>("jekyll-plugin") {
+ register<MavenPublication>("jekyllPlugin") {
artifactId = "jekyll-plugin"
from(components["java"])
}
}
+}
+
+dependencies {
+ implementation(project(":plugins:base"))
+ implementation(project(":plugins:gfm"))
} \ No newline at end of file
diff --git a/plugins/jekyll/src/main/kotlin/JekyllPlugin.kt b/plugins/jekyll/src/main/kotlin/JekyllPlugin.kt
index 0a0a2cc4..c4f7f2c7 100644
--- a/plugins/jekyll/src/main/kotlin/JekyllPlugin.kt
+++ b/plugins/jekyll/src/main/kotlin/JekyllPlugin.kt
@@ -1,133 +1,23 @@
package org.jetbrains.dokka.jekyll
import org.jetbrains.dokka.CoreExtensions
+import org.jetbrains.dokka.gfm.CommonmarkRenderer
import org.jetbrains.dokka.pages.*
import org.jetbrains.dokka.plugability.DokkaContext
import org.jetbrains.dokka.plugability.DokkaPlugin
-import org.jetbrains.dokka.plugability.single
-import org.jetbrains.dokka.renderers.DefaultRenderer
-import org.jetbrains.dokka.renderers.OutputWriter
-import org.jetbrains.dokka.resolvers.DefaultLocationProvider
-import org.jetbrains.dokka.resolvers.LocationProvider
-import org.jetbrains.dokka.resolvers.LocationProviderFactory
import java.lang.StringBuilder
class JekyllPlugin : DokkaPlugin() {
val renderer by extending {
- CoreExtensions.renderer providing { JekyllRenderer(it.single(CoreExtensions.outputWriter), it) }
+ CoreExtensions.renderer providing { JekyllRenderer(it) } applyIf { format == "jekyll" }
}
}
class JekyllRenderer(
- outputWriter: OutputWriter,
context: DokkaContext
-) : DefaultRenderer<StringBuilder>(outputWriter, context) {
- 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) {
- 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.start}.")
- } else {
- buildListItem(node.children, pageContext, "*")
- }
- }
-
- override fun StringBuilder.buildNewLine() {
- this.append(" \n")
- }
-
- fun StringBuilder.buildParagraph() {
- this.append("\n\n")
- }
-
- override fun StringBuilder.buildResource(node: ContentEmbeddedResource, pageContext: ContentPage) {
- this.append("Resource")
- }
-
- override fun StringBuilder.buildTable(node: ContentTable, pageContext: ContentPage) {
-
- 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)
- this.append(decorators)
- this.append(textNode.text.replace(Regex("[<>]"), ""))
- this.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()
- }
+) : CommonmarkRenderer(context) {
override fun buildPage(page: ContentPage, content: (StringBuilder, ContentPage) -> Unit): String {
val builder = StringBuilder()
@@ -137,46 +27,4 @@ class JekyllRenderer(
content(builder, page)
return builder.toString()
}
-
- override fun buildError(node: ContentNode) {
- println("Error")
- }
-
- private fun decorators(styles: Set<Style>): String {
- val decorators = StringBuilder()
- styles.forEach {
- when(it) {
- TextStyle.Bold -> decorators.append("**")
- TextStyle.Italic -> decorators.append("*")
- TextStyle.Strong -> decorators.append("**")
- TextStyle.Strikethrough -> decorators.append("~~")
- else -> Unit
- }
- }
- return decorators.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 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"
- )
- }
- }
} \ No newline at end of file