https://kotlinlang.org logo
Title
m

MartinZaubitzer

01/21/2020, 10:59 PM
Hi, I try to generate documentation using Dokka. Worked out great, but there is no specific format for GitlabWiki docs. Can someone please explain a little more in depth how I can create my own format? I know about this: https://github.com/Kotlin/dokka/issues/279 But it is not really helping me. I am unsure where to start and what actual to do. Thanks.
c

Casey Brooks

01/21/2020, 11:05 PM
Custom formats for Dokka aren’t for the faint-of-heart, currently, but it can be done. I maintain a project that uses Dokka to create JSON-formatted output, and you’re welcome to browse the source and copy my setup for yourself, though it’s probably much more customized than you’d want it for Markdown output https://github.com/copper-leaf/kodiak
An alternative you might consider is using my other project, Orchid, to generate a full website, rather than just a wiki. It supports deploying to GitLab Pages, and renders nicer-looking Kotlin docs alongside your wiki docs. strikt.io is a good example of a project site documented with Orchid, and you can follow this tutorial to get started https://orchid.run/wiki/learn/tutorials/how-to-document-kotlin
m

MartinZaubitzer

01/21/2020, 11:27 PM
Ok thanks, I will try with Gitlab Pages. Does Orchid support Android? I have tried setting it up and got stuck with: "The java plugin has been applied, but it's not compatible with the android plugins"
c

Casey Brooks

01/22/2020, 12:00 AM
You’ll want to set the Orchid project up in a different subproject and point it to your Android modules
👍 1