search

screen-editor / se

se is a screen oriented version of the classic UNIX text editor ed.
Other
39 stars 3 forks source link

Provide online documention / man page. #9

Open SirWumpus opened 2 years ago

SirWumpus commented 2 years ago

Providing online documentation and examples of the commands and usage might help new comers better evaluate the software without the need to install the package (assuming the distro has a pre-built package).

tcort commented 2 years ago

Maybe some tools can output the man pages as HTML for the website and/or maybe there's a neat way to show the help text on the website.

josephholsten commented 1 year ago

I’m a fan of pandoc. I usually go from markdown to roff & html, it’s also possible to go from roff to html, see https://pandoc.org/MANUAL.html#option--from

% pandoc --from=man --to=html man/se.1

Gives a reasonable page body (literally, just the part to put in <html><body>here</body></html>), but we’ll still need a template. I think ronn’s template looks great: https://rtomayko.github.io/ronn/ronn.1