Best tool to create a user guide for an open source project?

Question

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.

recrudesce · Accepted Answer

Github has a Wiki feature as part of the repo.https://docs.github.com/en/communities/documenting-your-proj...

verdverm · Answer

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.

mvkel · Answer

https://www.gitbook.com/

Jugurtha · Answer

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

johng · Answer

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

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.

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.