News for hackers. Stuff that matters.
Re:Technical documentation that just works by hamandcheese on Thursday May 27, 2021 @03:31AM (#27300361)
Not to downplay what seems to be a nice tool, but bundling markdown files into a static site is the easy part.

What I would love to see is a way to combine markdown pages with source-generated API docs from multiple languages.

In my case, we have Ruby, Java, Scala, Kotlin, Clojure and JS. All of these have their own independent ways of generating API documentation. It would be wonderful to bundle this all up into one static site, and able to reference classes and methods in any language and have it link together.

Re:Technical documentation that just works by oprypin on Thursday May 27, 2021 @04:30AM (#27300617)
That would be https://mkdocstrings.github.io/ except it currently doesn't have implementations for any of those languages.
Re:Technical documentation that just works by cryptos on Thursday May 27, 2021 @03:53AM (#27300451)
That could be done with Hugo, if the generated API docs are placed into the static assets folder of the Hugo project. I think you are looking for a tool that would support it out of the box, but it shouldn't be to hard to set up.
Re:Technical documentation that just works by hamandcheese on Thursday May 27, 2021 @12:07PM (#27304663)
Then you’ll end up with lots of micro-sites with very different designs and no unified search.