You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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.
The text was updated successfully, but these errors were encountered:
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.
Reokodoku
changed the title
GH workflow for man to html
Write documentation only once
May 14, 2024
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.
The text was updated successfully, but these errors were encountered: