jaredly / redoc

A clean & easy documentation generator for reason/bucklescript/ocaml
https://jaredforsyth.com/redoc/index.html
116 stars 11 forks source link

Generating MD files for Docusaurus #22

Open mlms13 opened 5 years ago

mlms13 commented 5 years ago

This is definitely more of a question than a bug report (or even feature request)...

I'm hoping to end up with Docusaurus docs for a library I'm working on. I'd like these docs to be a mix of hand-written "guide" pages and API docs generated from docblock comments in my code.

redoc's ability to make sense of both docblock comments and rei/mli interface files seems incredibly promising, but it generates a full HTML site, while Docusaurus expects to find Markdown pages. How suitable is redoc for this task, and where would you recommend I start digging in if I want to modify it for this use case?

Thanks for building this sweet tool!