Skip to content

Commit

Permalink
fix a few more things
Browse files Browse the repository at this point in the history
  • Loading branch information
jillesvangurp committed Sep 3, 2024
1 parent 24366c3 commit 442f0e3
Show file tree
Hide file tree
Showing 3 changed files with 2 additions and 12 deletions.
6 changes: 1 addition & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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") {

+"""
Expand Down

0 comments on commit 442f0e3

Please sign in to comment.