search

caddyserver / website

The Caddy website
154 stars 150 forks source link

Building website with custom module docs #384

Open ImpostorKeanu opened 6 months ago

ImpostorKeanu commented 6 months ago

Hi again!

Is there any documentation on how to build the website and have it reflect documentation for custom modules in the "JSON Config Structure"? I've found the moduledoc project, but haven't quite figured how to generate the desired output and marry it with the website content.

If someone is kind enough to give me a few breadcrumbs, maybe I can find the time to document and share the process (if it isn't already).

Thanks again for the phenomenal projects! They're becoming more and more critical to my work with each passing day.

mholt commented 6 months ago

Good question... there is not. The code that generates the module docs is open source but the website backend is niche (i.e. not generally useful) and not open source because it includes the account database and such.

But, perhaps separating out the module documentation from the rest of the website would be a good endeavor at some point, similar to how you can run godoc locally.

ImpostorKeanu commented 6 months ago

Got it! Thanks for considering the enhancement.