Open aSemy opened 3 months ago
Host the API reference documentation on GitHub Pages.
Links to original documentations? :)
Host the API reference documentation on GitHub Pages.
Links to original documentations? :)
Sorry, I don't understand, could you elaborate?
Which "API reference documentation" you want to collect? In common case original (JS documentation) is what required for user
Ahh I see! Well, if the Kotlin docs have the JS docs, then it will be displayed.
For example, properties in AccordionProps are documented:
But you want to see a link to the original JS library documentation? E.g. a link to https://mui.com/material-ui/api/accordion/#props. That sounds like something that the JS-to-Kotlin generator should do. But I don't think there's a standard way of getting a link to the docs... it might need to be configured per library?
Is your feature request related to a problem? Please describe.
I want to be able to look and search through at the available classes and functions on an easily accessible website.
I want to be able to create 'external links' in my own Dokka websites
Describe the solution you'd like
Create a Dokka HTML website.
Host the API reference documentation on GitHub Pages.
Describe alternatives you've considered
Searching the source code through GitHub (although this is not easy, and isn't pretty. It's also hard to link to. It doesn't work for external Dokka links).
Additional context
I see that the Gradle build config for this project is well structured and follows Gradle best practices. The official Dokka Gradle Plugin would unfortunately break this. Instead, I'd be happy to create a PR that would add Dokkatoo, which would be compatible.