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?
- plays well with typescript
- hosts on GitHub pages
Top comments (17)
Astro's Documentation uses Astro (Repo).
Documentationstarter template (Repo) (Open in StackBlitz).
Something to think about.
Seems viable for sure thanks I'll take a read
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
_docsdirectory and run
php hyde buildin 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/
Aw maybe when I give laravel a whirl but I don't have PHP on my system, still this might help others who have
Hyde is actually based on Laravel Zero (stripped down version of Laravel) so when you try Laravel you'll feel right at home :)
Is that something that would be helpful?
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!
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
Are you saying it needs... better documentation?
Yes I think so or perhaps that the existing docs need review
I am sorry to hear that.
I just followed the instructions and it worked fine. Perhaps another try could help.
You do not need a framework to generate static website. Vite can do most of job, github.com/taowen/vite-howto/tree/...
I'm not using vite in this project though for good reasons
Vite is becoming such a good thing!
Have you tried docusaurus?
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
Stripe recently launched Markdoc, apart from it the ones I would suggest for typescript are eleventy, nextra and react-static.
Thanks I'll get browsing!