Hi Guys, do you have any idea how to effectively g...
# javascript
m
Hi Guys, do you have any idea how to effectively generate api documentation for Kotlin JS library targets? Thank you!
c
What kind of API documentation? Source code API, like Dokka? Or HTTP API, like OpenAPI?
m
Source Code 🙂
c
Dokka works well
If you use MkDocs, see my experimental plugin; https://gitlab.com/opensavvy/automation/dokka-material-mkdocs
thank you color 1
m
I would like to publish platform-specific documentation, not just multiplatform
I would like to have docs for the generated js code
c
As in, you want documentation using JS syntax?
My best guess then would be to generate documentation from the generated
.d.ts
with e.g. TypeDoc
m
I would like to make the API documentation availaibe for JS api consumers
That is a good idea 🙂 Thanks! It would also be great if the jsdoc was included in the generated source
c
You should probably create a feature request for that, I don't think it's possible at the moment: https://kotl.in/issue
m
Okay, thank you for your help!
c
(if you do create an issue, share the link here, I'm curious to follow it)
👍 1
m
c
It does, yeah, thanks for the link
m
You are welcome! There does not seem to be any activity on it, though 😞
c
If you add a comment with an example of what you'd find this useful for, it may bring this to the attention
👍 1
m
Good idea