Hi! I’m evaluating Dokka for internal documentation of an Android project. My initial feeling has been highly positive thanks to gradle plugin. However, there is something that is really important to us that I couldn’t manage to do. There are multiple

README.md

files scattered around the project, mainly serving as package summaries. I want to include these markdown files, not necessarily named

README

, under package pages in Dokka. It should feel like browsing the project on Github. Is this at all possible or is there any other way that you would suggest?

Yeah, I've found that the dokka html output has limited customizability. Personally, I created a new gradle task to customize the html output. If you don't mind spending a few hours writing some dead-end code, then groovy file manipulation and Jsoup DOM manipulation can get you almost anything you want.

I think the best way to do this might be to generate

md

files using Dokka and then serve them using mkdocs. That's what Square does for LeakCanary

@Afzal Najam thanks for the suggestion. I haven’t yet checked

mkdocs

but surely will do now.