Hi. Newcomer here, learning on the job. We have a...
# getting-startedt
Thorbjørn Ravn Andersen
04/11/2023, 9:29 AMHi. Newcomer here, learning on the job. We have a need for richer documentation-in-code than what API-doc (jjavadoc/kdoc) similar to what e.g. AsciiDoc and Markdown can do, but it would be very beneficial to have it as part of the language itself to allow the documented code to be "live" and not copy-pasted. Is things like this being discussed here on slack, or elsewhere perhaps?
h
hfhbd
04/11/2023, 9:42 AMYou can use dokka and it’s plugin mechanism to create rich documentations from Kdoc. One sample: https://github.com/glureau/dokka-mermaid
🥰 1
a
Adam S
04/11/2023, 9:44 AMhttps://github.com/Kotlin/kotlinx-knit is very good for example-based documentation that’s automatically tested
The Kotlinx Serialization docs use it https://github.com/Kotlin/kotlinx.serialization/blob/99496a8cd20fec74d0dabbb2698d48795b405cc5/docs/serialization-guide.md
h
hfhbd
04/11/2023, 9:44 AMThere is also knit used by the stdlib https://github.com/Kotlin/kotlinx-knit
2 Views