dokka
dokka copied to clipboard
Kotlin
Ability to create multiple toplevel HTML documents
Is your feature request related to a problem? Please describe
Currently, the MultiModuleTask is able to generate toplevel documentation (Markdown files).
Unfortunately though, if more than 1 document is added, all documents get concatenated to the generated index.html.
Describe the solution you'd like
A simple way to generate multiple toplevel HTML files when including documentation in MultiModuleTask.
- Input path (source file)
- Output path (target file)
- Distinguishing the generated main index.html from other generated top level HTML documentation
- Linking between top-level documentation
Describe alternatives you've considered
An alternative right now would be to run the MultiModuleTask in a loop, one documentation file at a time, and renaming each generated index.html to the target file. This doesn't solve linking, but at least generates all of the required HTML documents.
Could you tell me what is your use case? What would it allow you to do and how it would improve your experience?
Could you tell me what is your use case? What would it allow you to do and how it would improve your experience?
@MarcinAman We use Dokka to document a platform product, which needs extensive top-level documentation. For instance how-to documentation, getting-started guides, domain-specific introductions, etc.
The goal here is to use Dokka for generating the complete customer-facing documentation. By being able to generate multiple top-level HTML documents from Markdown files, we would be able to add references to these documents to the main index.html.
@MarcinAman Adding this feature would effectively allow Dokka itself to generate and publish its own user documentation using only Dokka and not MkDocs - and all of that in a unified style and place with the API docs.
I still think this feature would be a great addition for small projects.
However, if you're going to have a MkDocs site anyway, I'm working on the opposite feature: embedding Dokka into MkDocs directly. You can follow the project here.
I still think this feature would be a great addition for small projects.
However, if you're going to have a MkDocs site anyway, I'm working on the opposite feature: embedding Dokka into MkDocs directly. You can follow the project here.
I might give this a try. Does it support versioning? We're using < 2.0.0 version of Dokka and generating dokkaGfmMultiModule, then using mike to deploy for each version.
@stevenzeck It does not support versioning at the moment because versioning is a paid feature of Material for MkDocs and I don't have access to it. The latest version only supports Dokka 2.0.0, but there were older versions which supported Dokka < 2.0.0 and Dokkatoo.