Update dokka to 1.4

Change the way how we render pages, so we parse .md files and then apply html layouts.

Do no render files other then .md or .html ones

.gitignore

@@ -4,3 +4,4 @@
 build/
 gradle/
 lib/
+out

build.gradle.kts

@@ -9,7 +9,7 @@ plugins {
 }
 
 group = "com.virtuslab.dokka"
-version = "0.1.1"
+version = "0.1.3-SNAPSHOT"
 
 tasks.withType(KotlinCompile::class).all {
     val language_version: String by project
@@ -34,11 +34,12 @@ dependencies {
     implementation("org.jetbrains.dokka:dokka-base:$dokka_version")
     implementation("com.vladsch.flexmark:flexmark-all:0.42.12")
     implementation("nl.big-o:liqp:0.6.7")
-    implementation("org.jetbrains.kotlinx:kotlinx-html-jvm:0.6.10")
+    implementation("org.jetbrains.kotlinx:kotlinx-html-jvm:0.7.2")
 
     implementation("junit:junit:4.13")
 
     dokkaHtmlPlugin(project(":"))
+    testImplementation("org.jetbrains.dokka:dokka-core:$dokka_version")
 }
 
 // Gradle metadata
@@ -83,5 +84,5 @@ publishing {
 
 // Configure dokka
 tasks.dokkaHtml {
-    pluginsConfiguration += "ExternalDocsTooKey" to "documentation"
+    pluginsConfiguration.put("ExternalDocsTooKey",  "documentation")
 }

documentation/_layouts/vl_html_layout.html

@@ -0,0 +1,7 @@
+<header>
+    Powered by <a href="https://www.virtuslab.com/">VirtusLab</a>
+</header>
+
+<div>
+    {{ content }}
+</div>

documentation/docs/static-page/links.md

@@ -0,0 +1,12 @@
+---
+layout: vl_header
+title: Links
+---
+
+## Links
+
+Our side supports stadnard markdown links:
+ - TODO Using standard [urls](https://pl.wikipedia.org/wiki/Uniform_Resource_Locator)
+ - TODO To [other pages](/docs/static-page/random.html) (or [md base file](/docs/static-page/tables.md)) in our documentation that using paths relative to root od documentation e.g. `/docs/static-page/random.html` for this project
+ - TODO To [other pages](/docs/static-page/samples/random.html) (or [md base file](samples/tables.md)) in our documentation that using paths relative to this file e.g. using `random.html` (or `tables.md`)
+ - TODO To API using `[fully.quallifty.Name]`  

documentation/docs/static-page/random.html → documentation/docs/static-page/random.md

@@ -1,6 +1,6 @@
 ---
 layout: vl_header
-title: Sample html page
+title: Sample md page
 ---
 
 Hello world!

documentation/docs/static-page/samples/html_template.md

@@ -0,0 +1,6 @@
+---
+layout: vl_html_layout
+title: Use Html template
+---
+
+## Test 123

documentation/docs/static-page/samples/index.md

@@ -0,0 +1,6 @@
+---
+layout: vl_header
+title: Samples
+---
+
+Samples for our **plugin**

documentation/docs/static-page/samples/no_md_nor_html.txt

@@ -0,0 +1 @@
+I am text file!

documentation/docs/static-page/samples/plainFramelessHtmlIndex/index.html

@@ -0,0 +1,4 @@
+---
+hasFrame: false
+---
+<h1>No frame!</h1>

documentation/docs/static-page/samples/plainHtmlIndexFile/index.html

@@ -0,0 +1 @@
+<h1>Plain html file</h1>

documentation/docs/static-page/samples/plainIndexFile/index.md

@@ -0,0 +1 @@
+## Plain file

documentation/docs/static-page/samples/plain_html_file.html

@@ -0,0 +1 @@
+<h1>Plain Html file</h1>

documentation/docs/static-page/samples/plain_md_file.md

@@ -0,0 +1 @@
+# Plain Md file

documentation/docs/static-page/samples/tables.md

@@ -0,0 +1,21 @@
+---
+layout: vl_html_layout
+title: Tables
+---
+
+## Tables
+
+
+Some random table (to show how we render it).
+
+## SBT Commands Cheat Sheet ##
+The basics of working with Dotty codebase are documented [here](https://dotty.epfl.ch/docs/contributing/getting-started.html) and [here](https://dotty.epfl.ch/docs/contributing/workflow.html). Below is a cheat sheet of some frequently used commands (to be used from SBT console – `sbt`).
+
+
+|                        Command                       |                                                          Description                                                          |
+| ---------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |
+| `dotc ../issues/Playground.scala`                    | Compile the given file – path relative to the Dotty directory. Output the compiled class files to the Dotty directory itself. |
+| `dotr Playground`                                    | Run the compiled class `Playground`. Dotty directory is on classpath by default.                                              |
+| `repl`                                               | Start REPL                                                                                                                    |
+| `testOnly dotty.tools.dotc.CompilationTests -- *pos` | Run test (method) `pos` from `CompilationTests` suite.                                                                        |
+| `testCompilation sample`                             | In all test suites, run test files containing the word `sample` in their title.                                               |

documentation/index.md

@@ -8,7 +8,7 @@ layout: vl_header
 
 **Yes, this page was generated using dokka-site**
 
-You can learn more from out [documentation](dokka-site/index.html).
+You can learn more from our [documentation](dokka-site/index.html).
 
 ## Getting started
 

gradle.properties

@@ -1,6 +1,6 @@
 kotlin.code.style=official
 
-kotlin_version=1.4-M3
-dokka_version=1.4.0-rc
+kotlin_version=1.4.0
+dokka_version=1.4.0
 
 language_version=1.4

settings.gradle.kts

@@ -17,5 +17,6 @@ pluginManagement {
         mavenCentral()
         jcenter()
         gradlePluginPortal()
+        mavenLocal()
     }
 }

src/main/kotlin/com/virtuslab/dokka/site/StaticSitePlugin.kt

@@ -27,7 +27,7 @@ class StaticSitePlugin : DokkaPlugin() {
 
     val customRenderer by extending {
         (CoreExtensions.renderer
-                providing { ctx -> ExternalDocsToolRenderer(ctx) }
+                providing { ctx -> RendererDispatcher(ctx) }
                 override dokkaBase.htmlRenderer)
     }
 

src/main/kotlin/com/virtuslab/dokka/site/contentNodes.kt

@@ -0,0 +1,26 @@
+package com.virtuslab.dokka.site
+
+import org.jetbrains.dokka.model.DisplaySourceSet
+import org.jetbrains.dokka.model.properties.PropertyContainer
+import org.jetbrains.dokka.pages.*
+
+data class PartiallyRenderedContent(
+    val page: PreResolvedPage,
+    override val children: List<ContentNode>,
+    override val dci: DCI,
+    override val sourceSets: Set<DisplaySourceSet>,
+    override val style: Set<Style> = emptySet(),
+    override val extra: PropertyContainer<ContentNode> = PropertyContainer.empty()
+) : ContentNode {
+    override fun hasAnyContent(): Boolean = children.find { hasAnyContent() } != null
+
+    override fun withNewExtras(newExtras: PropertyContainer<ContentNode>): ContentNode =
+        copy(extra = extra)
+
+    override fun withSourceSets(sourceSets: Set<DisplaySourceSet>): ContentNode =
+        copy(sourceSets = sourceSets)
+
+    val allResources: List<String> by lazy {
+        page.render("").resources
+    }
+}

src/main/kotlin/com/virtuslab/dokka/site/locationProvider.kt

@@ -1,6 +1,6 @@
 package com.virtuslab.dokka.site
 
-import org.jetbrains.dokka.base.resolvers.local.DefaultLocationProvider
+import org.jetbrains.dokka.base.resolvers.local.DokkaLocationProvider
 import org.jetbrains.dokka.base.resolvers.local.LocationProvider
 import org.jetbrains.dokka.base.resolvers.local.LocationProviderFactory
 import org.jetbrains.dokka.pages.PageNode
@@ -13,10 +13,17 @@ class StaticSiteLocationProviderFactory(private val ctx: DokkaContext) : Locatio
     }
 }
 
-class StaticSiteLocationProvider(ctx: DokkaContext, pageNode: RootPageNode) : DefaultLocationProvider(pageNode, ctx) {
+class StaticSiteLocationProvider(ctx: DokkaContext, pageNode: RootPageNode) : DokkaLocationProvider(pageNode, ctx) {
     override fun pathTo(node: PageNode, context: PageNode?): String =
-        if (node is BaseStaticSiteProcessor.BasePageNode && node.dri.contains(docsRootDRI))
-            "index"
+        if (node is BaseStaticSiteProcessor.StaticPageNode)
+            if (node.dri.contains(docsRootDRI)) "index"
+            else {
+                // replace title with original markdown file name
+                val original = super.pathTo(node, context)
+                val paths = original.split("/")
+                val fileName = node.loadedTemplate.file.name
+                (paths.dropLast(1) + listOf(fileName)).joinToString("/")
+            }
         else
             super.pathTo(node, context)
 }