Hacker News new | ask | show | jobs
by Grimm1 1865 days ago
This looks great, I looked on the API but I'm not sure if I'm missing this, is it possible to serve documentation to Docusaurus and have it generate from that served documentation? I've been working on, what I consider, a pretty powerful auto documentation tool and it'd be cool to integrate with this to produce self-hosted doc sites from our auto generated documentation.

I suppose we could generate separate markdown files as well and pass them to the CLI!

Either way I think I'll be adding support for Docusaurus in the near future, cool stuff!

1 comments

I don't understand what you mean sorry
Is there a way to keep Docusarus running like a live service and make an API request to it to generate documentation pages?

Or is it strictly an offline cli tool?

not sure to understand, any concrete use-case to share?

Docusaurus is a SSG, does not need a server in production and it's not a goal. If something happens live, then it can only happen on your dev computer

The use case is we automatically generate documentation on the fly, so I'd want to be able to then also automatically update their documentation site with our new docs we've generated.

From what you're saying it sounds like the best route for us to support Docusaurus sites is to generate the markdown files and let them update their site themselves, which is fine I just wanted to make sure I wasn't missing anything myself.