Ask HN: Best tool to create a user guide for an open source project? 4 points by da39a3ee 4y ago ↗ HN 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.
[–] verdverm 4y ago ↗ 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.
[–] recrudesce 4y ago ↗ Github has a Wiki feature as part of the repo.https://docs.github.com/en/communities/documenting-your-proj...
[–] Jugurtha 4y ago ↗ Could you share the repository link? You may receive useful feedback from people looking at it.
5 comments
[ 2.7 ms ] story [ 25.2 ms ] threadI use Hugo for https://cuetorials.com and my other sites. Generally would recommend markdown to html setup.
https://docs.github.com/en/communities/documenting-your-proj...