Open Reokodoku opened 4 months ago
That's interesting. I was considering creating a whole page, and have the current one be something like /lib
. Then, we could have /docs
which would be the documentation of the program itself.
The only problem I see when unifying the documentation is that the manpage format is not the ideal one for web documentation. I would prefer something like https://docusaurus.io or GitBook
Maybe we can write the documentation in markdown (so we can use it with x
site) and then convert it to manpages with tools like ronn
, but I think that in this way the markdown file layout will be forced.
Yeah, that's something to consider...
I think it is a good idea to serve a GitHub pages site with HTML pages generated from man pages. Now for documentation we have to write it twice: once in markdown and once in man.
If we serve the man pages we can write less documentation.