Arnau478 / hevi

Hex viewer
https://arnau478.github.io/hevi/
GNU General Public License v3.0
72 stars 3 forks source link

Write documentation only once #27

Open Reokodoku opened 4 months ago

Reokodoku commented 4 months ago

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.

Arnau478 commented 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

Reokodoku commented 4 months ago

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.

Arnau478 commented 4 months ago

Yeah, that's something to consider...