kotlin4example

Literate programming for Kotlin. Write markdown based documentation for your kotlin project with working examples. (by jillesvangurp)

Kotlin4example Alternatives

Similar projects and alternatives to kotlin4example

NOTE: The number of mentions on this list indicates mentions on common posts plus user suggested alternatives. Hence, a higher number means a better kotlin4example alternative or higher similarity.

kotlin4example reviews and mentions

Posts with mentions or reviews of kotlin4example. We have used some of these posts to build our list of alternatives and similar projects. The last one was on 2021-05-27.
  • Technical documentation that just works
    12 projects | news.ycombinator.com | 27 May 2021
    This tool seems like it is a nice markdown based CMS but I don't see too many features related to the more difficult parts of doing technical documentation. Like having working code samples.

    I attempted a Kotlin centric documentation framework a while ago to address this: https://github.com/jillesvangurp/kotlin4example

    I mainly use it to generate the documentation for my Elasticsearch Kotlin Client (jillesvangurp/es-kotlin-client). The idea there is that all examples and source samples are correctly compiling Kotlin code that I can get the output of when they run (e.g. a println). Running the tests, actually generates the documentation markdown. Using a dsl and multiline strings, I can mix lambda code blocks, markdown, or markdown inside files. For the lambda blocks, it figures out the source and line numbers using reflection. But it can also grab source samples based on comment markers. For bigger blobs of markdown, it's easier to grab the content from markdown files. For smaller sections of markdown, I can use inline multi line strings or a Kotlin DSL.

    The main benefit of this is that my examples update as I change and refactor the code base. Also, since it runs as part of my tests, I know when examples break.

Stats

Basic kotlin4example repo stats
1
15
6.0
about 1 month ago

Sponsored
SaaSHub - Software Alternatives and Reviews
SaaSHub helps you find the best software and product alternatives
www.saashub.com