HN Explorer

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

6 points by mudge ↗ HN
I am looking for some good options to create a documentation website for an open source project. I am looking for something that is free or very inexpensive and that is very easy to use and setup. It could be a tool, service or hosting platform. I am not a web developer but I know markdown.

Do you know of some good options?

8 comments

[ 2.3 ms ] story [ 35.6 ms ] thread
djdjsjejb
imo gitbook.com seems to be the easiest for nondevs
moomoo11
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

zlacker
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.
[deleted]
(comment deleted)
bogomil
Can you tell more about the project? For a small one launching a complicated docs system could be overhead.
aborsy
Sphinx, MkDocs, Docusaurus.