Skip to content
This repository has been archived by the owner on Jun 2, 2024. It is now read-only.

try a new doc generator #38

Open
meleu opened this issue Mar 27, 2020 · 4 comments
Open

try a new doc generator #38

meleu opened this issue Mar 27, 2020 · 4 comments

Comments

@meleu
Copy link
Contributor

meleu commented Mar 27, 2020

I'm tempted to change from mkdocs to docsify.

Also, use gitalk for comments.

@televandalist
Copy link
Member

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

@meleu
Copy link
Contributor Author

meleu commented Feb 13, 2021

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
Copy link
Member

Sanaki commented Feb 13, 2021

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
Copy link
Contributor Author

meleu commented Sep 12, 2022

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).

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants