Looking for open source documentation generator

4 points by withshubh 2y ago ↗ HN

I have worked with docusauras and I believe that initially, it requires too much developer effort to make it look beautiful or customise.

Got to know about Docus.dev and Nextra.site but didn't find any examples that have API docs (using OpenAPI specs)

6 comments

[ 2.2 ms ] story [ 25.8 ms ] thread

warrenm 2y ago ↗

First problem ... define what you mean by "documentation"

We talking javadocs? MSDN? IBM developerWorks? Docs.Splunk? ReadTheDocs.io? GitHub readme.md? ...?

withshubh 2y ago ↗

Did you check the websites I mentioned in the description?

warrenm 2y ago ↗

Yes - but that's still not automating the documentation ... it's only [potentially] automating presenting it

So ... back to my initial narrowing-down inquiry :)

mikewarot 2y ago ↗

Good documentation can't be automated. It requires someone to carefully craft working examples of all the parameters and functions that are available, so you can copy/paste them into a program to try them out.

I'd expect at least two separate people are required... a writer and an editor.

withshubh 2y ago ↗

It's not about automating the documentation. It is about the static site generators for documentation. Ex: https://docusaurus.io/

flexwie 2y ago ↗

Astro has tools to build documentation from OpenAPI specs. Found it a bit easier to get started with customization compared to docusaurus.