RetroAchievements / docs-archive

RADocs
https://docs-archive.retroachievements.org
52 stars 10 forks source link

try a new doc generator #38

Open meleu opened 4 years ago

meleu commented 4 years ago

I'm tempted to change from mkdocs to docsify.

Also, use gitalk for comments.

televandalist commented 4 years ago

Docsify seems pretty neat. Would be a good opportunity to give the docs an overhaul, too. SIgn me up

meleu commented 3 years ago

Another approach I'm considering:

just-the-docs seems to be an extremely simple and useful jekyll theme we could use for a new documentation website.

Live Demo

Note: using a jekyll theme would solve the problem of the docs site being dependent only on me (bus factor = 1). I could enable a "github actions" to regenerate the website after every single commit (just like I did in the RANews repo).

Sanaki commented 3 years ago

My only major objection to docsify is that it requires npm to work with it locally, which is mildly vomit-inducing. That said, I believe the libretro docs use mkdocs and auto-publish just fine. Might be worth checking how they do that.

meleu commented 2 years ago

This one caught my attention recently: https://getdoks.org/

Besides the good design, another benefit is that it's hugo based (which means really neat support for multilingual content).