Ask HN: Best way to make a documentation website for an open-source project?

6 pointsposted 4 months ago
by mudge

Item id: 45639211

8 Comments

moomoo11

4 months ago

What’s the complexity of your project? If you’re not a developer and it’s a simple project, I’d say do notion pages.

If devs like it I’m sure they will contribute to make a legit docs site for it.

Good way to start imo that has zero friction (for you) and I wouldn’t personally mind it since you get public URL’s.

Or use Codex or CC to make a markdown site hosted on GitHub io

user

4 months ago

[deleted]

zlacker

4 months ago

A lot of static site generators support rendering markdown to HTML, can't give any specifics since you probably have your own preferred stack/language to use.

bogomil

4 months ago

Can you tell more about the project? For a small one launching a complicated docs system could be overhead.

aborsy

4 months ago

Sphinx, MkDocs, Docusaurus.

djdjsjejb

4 months ago

imo gitbook.com seems to be the easiest for nondevs

nacozarina

4 months ago

spin up a mediawiki container