3 ms·
Ask HN: Best tool to create a user guide for an open source project?
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.
- johng 5y agoRead a little about Sphinx the other day. Might be an option.
- verdverm 5y agoYou can make a docs folder with more markdown, you can relative link them on GitHub. I use Hugo for https://cuetorials.com https://cuetorials.com and my other sites. Generally would recommend markdown to html setup.
- mvkel 5y agohttps://www.gitbook.com/ https://www.gitbook.com/
- recrudesce 5y agoGithub has a Wiki feature as part of the repo. https://docs.github.com/en/communities/documenting-your-project-with-wikis/about-wikis https://docs.github.com/en/communities/documenting-your-proj...
- Jugurtha 5y agoCould you share the repository link? You may receive useful feedback from people looking at it.