Deployed 730ff85 with MkDocs version: 1.5.3

DocsCopier.main.kts

@@ -0,0 +1,98 @@
+#!/usr/bin/env kotlin
+
+@file:Repository("https://repo.maven.apache.org/maven2/")
+//@file:Repository("https://oss.sonatype.org/content/repositories/snapshots")
+//@file:Repository("file:///Users/you/.m2/repository")
+@file:DependsOn("org.jetbrains.kotlinx:kotlinx-coroutines-core:1.5.0")
+
+@file:CompilerOptions("-opt-in=kotlin.RequiresOptIn")
+@file:Suppress("experimental_is_not_enabled")
+
+import kotlinx.coroutines.*
+import java.io.File
+import java.nio.file.Paths
+import kotlin.time.ExperimentalTime
+import kotlin.time.measureTime
+
+val projectDir: File = Paths.get("").toFile().let { currentDir: File ->
+    when (val dirName = currentDir.absoluteFile.name) {
+        "docs" -> currentDir.absoluteFile.parentFile
+        "refreshVersions" -> currentDir
+        else -> currentDir.also {
+            System.err.println("Warning: unexpected name for the current dir:")
+            System.err.println("dir name: $dirName")
+            System.err.println("full path: $currentDir")
+        }
+    }
+}
+
+val docsDir = projectDir.resolve("docs")
+
+// Regex inspired by http://blog.michaelperrin.fr/2019/02/04/advanced-regular-expressions/
+// If needed, look at the article again to support nested brackets (not needed so far).
+//language=RegExp
+val linksRegex = """\[(?<text>.+)\]\((?<url>[^) ]+)(?: "(?<title>.+)")?\)""".toRegex()
+val gitMainBranchUrl = "https://github.com/jmfayard/refreshVersions/tree/main"
+
+suspend fun readTextWithAdaptationForMkDocs(sourceFile: File): String = Dispatchers.Default {
+    Dispatchers.IO {
+        sourceFile.readText()
+    }.replace(linksRegex) withRelativeLinksTranslated@{ matchResult ->
+        val groups = matchResult.groups
+        val urlGroup = groups[2]!!
+        val url: String = urlGroup.value.trim()
+
+        fun matchWithReplacedUrl(replacement: String): String {
+            val offset = -matchResult.range.first
+            val rangeToReplaceInMatch = (urlGroup.range.first + offset)..(urlGroup.range.last + offset)
+            return matchResult.value.replaceRange(rangeToReplaceInMatch, replacement)
+        }
+
+        if ("://" in url || url.startsWith('#')) { // Leave external and same-page links as-is.
+            return@withRelativeLinksTranslated matchResult.value
+        }
+        if (url.substringBeforeLast('#').endsWith(".md")) { // Relative links to markdown files.
+            return@withRelativeLinksTranslated when {
+                url.startsWith("docs/") -> matchWithReplacedUrl(replacement = url.substringAfter("docs/"))
+                else -> matchResult.value // Leave others as-is.
+            }
+        }
+        if ('.' !in url.substringAfterLast('/', missingDelimiterValue = ".")) { // Leave links to paths as-is.
+            return@withRelativeLinksTranslated matchResult.value
+        }
+
+        // We want to rewrite relative links to files that are not part of the documentation (e.g. Kotlin files)
+        // to links pointing to the link in the GitHub repository.
+        val sourceDir = sourceFile.parentFile ?: projectDir
+        val newPath = sourceDir.relativeTo(projectDir).resolve(url).normalize()
+        matchWithReplacedUrl(replacement = "$gitMainBranchUrl/$newPath")
+    }
+}
+
+
+suspend fun copyAdaptedTopLevelMarkdownFiles(): Unit = coroutineScope {
+    val namesOfTopLevelMarkdownFiles = listOf(
+        "CHANGELOG.md",
+    )
+    namesOfTopLevelMarkdownFiles.forEach { fileName ->
+        launch {
+            val newContent = readTextWithAdaptationForMkDocs(projectDir.resolve(fileName))
+            val targetFile = docsDir.resolve(fileName)
+            Dispatchers.IO {
+                targetFile.writeText(newContent)
+            }
+        }
+    }
+}
+
+
+println("Copying the docs…")
+
+@OptIn(ExperimentalTime::class)
+val copyDuration = measureTime {
+    runBlocking(Dispatchers.Default) {
+        launch { copyAdaptedTopLevelMarkdownFiles() }
+    }
+}
+
+println("Done! Took $copyDuration")