Skip to content

Releases: jillesvangurp/kotlin4example

fix github links

13 Mar 07:29
Compare
Choose a tag to compare

Small fix that changes the links to github to have the word blob instead of tree in them. On some repos it redirects old links but not on all.

reindentation bug fix

17 Feb 10:01
Compare
Choose a tag to compare

reindentation bug where it was not detecting indentation correctly if it matches the desired one

1.1.3

17 Feb 09:46
Compare
Choose a tag to compare
  • implement more robust indentation for code blocks

v1.1.2

12 Jan 17:05
Compare
Choose a tag to compare
  • minor refactoring
  • add a DslMarker annotation

Deprecate suspendingExample

31 Dec 13:08
Compare
Choose a tag to compare
  • Examples are now always suspending blocks. This simplifies the API further.
  • mdCodeBlock is no longer private

API cleanup

31 Dec 04:24
Compare
Choose a tag to compare

This release cleans up the kotlin API a bit.

  • block and suspendingBlock are deprecated. The replacements are example and suspendingExample. The ReplaceWith should do the right things mostly. However, it does not preserve the arrow and "Captured output" String.
  • example returns an ExampleOutput instance with a Result<T> of whatever the block returns plus the captured stdout as a string

Add captureBlockReturnValue param

01 Apr 03:37
Compare
Choose a tag to compare

Add captureBlockReturnValue: Boolean = true to block and suspendingBlock so you can opt out of the return value being printed.

fix bug with suspendingBlock

28 Jul 11:38
Compare
Choose a tag to compare

Update the regular expression so it won't fail on suspendingBlocks

1.0 release

28 Jul 09:55
Compare
Choose a tag to compare

Decided to make this a 1.0 release as I seem to have most features that I need at this point.

There is only 1 change since the last version:

  • added suspendingBlock so you can document co-routine logic as well without having to put a runBlocking in each block

Add a few small features

27 Feb 15:38
Compare
Choose a tag to compare

This version adds a few nice features:

  • you can now define sections and sub sections section("Section") { ... }. The block is the parent Kotlin4Example instance so this works nicely for structuring things too.
  • fix a few issues with code snippets and support all the code block optional parameters
  • allow loading markdown fragments so they can be kept in .md files. This seems nicer for larger bits of text.