Hacker Newsnew | past | comments | ask | show | jobs | submitlogin
Ask HN: Best tool to create a user guide for an open source project?
4 points by da39a3ee on Nov 23, 2021 | hide | past | favorite | 5 comments
My README.md has got too large. I think I need to create a user guide / manual. What tool should I use? The project is hosted on github.


Github has a Wiki feature as part of the repo.

https://docs.github.com/en/communities/documenting-your-proj...


You can make a docs folder with more markdown, you can relative link them on GitHub.

I use Hugo for https://cuetorials.com and my other sites. Generally would recommend markdown to html setup.


https://www.gitbook.com/


Could you share the repository link? You may receive useful feedback from people looking at it.


Read a little about Sphinx the other day. Might be an option.




Guidelines | FAQ | Lists | API | Security | Legal | Apply to YC | Contact

Search: