roperzh / jroff

Man pages parser written in JavaScript, supports `an` and `doc` macros - WIP
MIT License
77 stars 15 forks source link

Online man page styler from a URL of your choice #1

Open Ircama opened 7 years ago

Ircama commented 7 years ago

Congratulations for your work.

I would suggest to add a github page to your repository, which can be used to allow rendering the man page of any troff document available on the web by appending the related URL as parameter to that page, like this:

https://ircama.github.io/osm-carto-tutorials/manpage.html?url=https://raw.githubusercontent.com/openstreetmap/osm2pgsql/master/docs/osm2pgsql.1

In this very rough example (to be removed as soon as a better solution will be available), the rendered document is for instance https://raw.githubusercontent.com/openstreetmap/osm2pgsql/master/docs/osm2pgsql.1 The github page is https://github.com/Ircama/osm-carto-tutorials/blob/gh-pages/manpage.html

The inspiration for this idea is from https://matteobrusa.github.io/md-styler/

BTW, while testing some man pages with this example, I found some minor errors which I will report to you through specific github issues.

roperzh commented 7 years ago

Hello @Ircama,

I would suggest to add a github page to your repository, which can be used to allow rendering the man page of any troff document available on the web by appending the related URL as parameter to that page.

This sounds like a really good idea! if you want to improve your page instead of deleting it, I will gladly add a link to the README and other places.

BTW, while testing some man pages with this example, I found some minor errors which I will report to you through specific github issues.

Thank you so much for all the issues, they help a lot. I know that the parser is in alpha state, so sorry about that.

Ircama commented 7 years ago

if you want to improve your page instead of deleting it, I will gladly add a link to the README and other places.

Thanks, but do not worry. I would not suggest this as that code is just a temporary work and needs optimization. I'm not going to improve it any further anyway.

dspinellis commented 6 years ago

I am working on this; see manview.