From 442f0e30ae29f69e9aad1de24cf6c3509ee5612b Mon Sep 17 00:00:00 2001 From: Jilles van Gurp Date: Tue, 3 Sep 2024 12:45:28 +0200 Subject: [PATCH] fix a few more things --- README.md | 6 +----- .../kotlin/com/jillesvangurp/kotlin4example/docs/intro.md | 2 +- .../kotlin/com/jillesvangurp/kotlin4example/docs/readme.kt | 6 ------ 3 files changed, 2 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index a77555e..48ed9be 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ and always up to date. And making it easy to include examples with your code low This library is intended for anyone that publishes some kind of Kotlin library or code and wants to document their code using Markdown files that contain working examples. -## Get started +## Gradle Add the dependency to your project and start writing some documentation. See below for some examples. I tend to put my documentation code in my tests so running the tests produces the documentation as a side effect. @@ -287,10 +287,6 @@ mdCodeBlock( ## Advanced topics -### Organizing pages - -A manual typically contains multiple pages. So, it helps to get organized a little. - ### Context receivers A new feature in Kotlin that you currently have to opt into is context receivers. diff --git a/src/test/kotlin/com/jillesvangurp/kotlin4example/docs/intro.md b/src/test/kotlin/com/jillesvangurp/kotlin4example/docs/intro.md index cc4663c..8f0f497 100644 --- a/src/test/kotlin/com/jillesvangurp/kotlin4example/docs/intro.md +++ b/src/test/kotlin/com/jillesvangurp/kotlin4example/docs/intro.md @@ -7,7 +7,7 @@ and always up to date. And making it easy to include examples with your code low This library is intended for anyone that publishes some kind of Kotlin library or code and wants to document their code using Markdown files that contain working examples. -## Get started +## Gradle Add the dependency to your project and start writing some documentation. See below for some examples. I tend to put my documentation code in my tests so running the tests produces the documentation as a side effect. diff --git a/src/test/kotlin/com/jillesvangurp/kotlin4example/docs/readme.kt b/src/test/kotlin/com/jillesvangurp/kotlin4example/docs/readme.kt index 61d97d3..e6beb13 100644 --- a/src/test/kotlin/com/jillesvangurp/kotlin4example/docs/readme.kt +++ b/src/test/kotlin/com/jillesvangurp/kotlin4example/docs/readme.kt @@ -261,12 +261,6 @@ val readmeMarkdown by k4ERepo.md { } section("Advanced topics") { - subSection("Organizing pages") { - +""" - A manual typically contains multiple pages. So, it helps to get organized a little. - """.trimIndent() - - } subSection("Context receivers") { +"""