DEV Community

Adam Crockett
Adam Crockett

Posted on

Best static docs generator for develor experience?

I'm looking to generate static docs but I don't want to do a lot to make it happen other than maintain a config file and maybe some markdown.

In your experience what is the best static docs website generator?

Extra credit:

  • plays well with typescript
  • hosts on GitHub pages

Discussion (17)

Collapse
peerreynders profile image
peerreynders • Edited on

Astro's Documentation uses Astro (Repo).

Something to think about.

Collapse
adam_cyclones profile image
Adam Crockett Author

Seems viable for sure thanks I'll take a read

Collapse
codewithcaen profile image
CodeWithCaen

Sorry for the shameless self promotion, but the software I am currently developing sounds like it's made just for you. It's called HydePHP, but don't let the name fool you, you actually don't need to write a single line of PHP to use it. Simply install it, add Markdown pages in the _docs directory and run php hyde build in your terminal.

Hyde will automatically create a beautiful static HTML documentation site based on your Markdown. You can even add Torchlight for amazing syntax highlighting.

Here is a link to the documentation site which is both built with Hyde and is hosted on GitHub pages and is actually compiled and deployed in a GitHub action. hydephp.com/docs/

Collapse
adam_cyclones profile image
Adam Crockett Author

Aw maybe when I give laravel a whirl but I don't have PHP on my system, still this might help others who have

Collapse
codewithcaen profile image
CodeWithCaen

Hyde is actually based on Laravel Zero (stripped down version of Laravel) so when you try Laravel you'll feel right at home :)

Collapse
dimitarstbc profile image
Dimitar Stoev

Is that something that would be helpful?

docsify.js.org/#/

I have used it in the past and it if I remember correctly it is fast easy and clean.

Check it out and I hope it is helpful!

Collapse
adam_cyclones profile image
Adam Crockett Author

I like it but seems like the instructions to install are broken, I worked around it by guessing and using npx but still couldn't get it to work quite right, a shame because compared to others it's a nice looking thing out of the box

Collapse
moopet profile image
Ben Sinclair

Are you saying it needs... better documentation?

Thread Thread
adam_cyclones profile image
Adam Crockett Author

Yes I think so or perhaps that the existing docs need review

Collapse
dimitarstbc profile image
Dimitar Stoev

I am sorry to hear that.
I just followed the instructions and it worked fine. Perhaps another try could help.

Collapse
taowen profile image
Tao Wen

You do not need a framework to generate static website. Vite can do most of job, github.com/taowen/vite-howto/tree/...

Collapse
adam_cyclones profile image
Adam Crockett Author

I'm not using vite in this project though for good reasons

Collapse
adam_cyclones profile image
Adam Crockett Author

Vite is becoming such a good thing!

Collapse
requestlyio profile image
Requestly

Have you tried docusaurus?

Collapse
adam_cyclones profile image
Adam Crockett Author

Using it, white complex but it does work, I think CSS wise it's not as clean as some other solutions and I don't really want to be poking around in the CSS to much

Collapse
asheeshh profile image
ashish

Stripe recently launched Markdoc, apart from it the ones I would suggest for typescript are eleventy, nextra and react-static.

Collapse
adam_cyclones profile image
Adam Crockett Author

Thanks I'll get browsing!