msn page / web reference / README.md #83

New Issue

cmccabe · 2020-01-19T02:11:45Z

cmccabe commented

2020-01-19 02:11:45 +00:00

I created a linkulator.1.html webpage, somewhat in man page style, and added it to the repo. It is also, for now, hosted at https://rawtext.club/~cmccabe/linkulator.1.html

We should create a master reference page (in markdown?) that can be converted to man page, webpage and README file formats -- or at least, with content that can be used across these formats so that they are consistent. The webapage does not need to remain in man page format; I just did it to see what it would look like.

I created a linkulator.1.html webpage, somewhat in man page style, and added it to the repo. It is also, for now, hosted at https://rawtext.club/~cmccabe/linkulator.1.html We should create a master reference page (in markdown?) that can be converted to man page, webpage and README file formats -- or at least, with content that can be used across these formats so that they are consistent. The webapage does not need to remain in man page format; I just did it to see what it would look like.

asdf commented

2020-01-29 05:42:30 +00:00

I like this idea. Reusing as much as possible would save time and effort.

These documents tend to have different purposes - a man page is like an instruction booklet, and probably does not include installation instructions like the README.md would. What are your thoughts as to how this could be managed?

I like this idea. Reusing as much as possible would save time and effort. These documents tend to have different purposes - a man page is like an instruction booklet, and probably does not include installation instructions like the README.md would. What are your thoughts as to how this could be managed?

sloum commented

2020-01-29 05:59:00 +00:00

It seems like if it was done in markdown as a man page, installation instructions, and background info/faq/misc that a script to cat them together into various forms and convert to final formats could be written up. Not sure if that over-complicates or not.

I use txt2man to help get manpages started... there may be a version or something similar that will convert from markdown. Not sure.

It seems like if it was done in markdown as a man page, installation instructions, and background info/faq/misc that a script to cat them together into various forms and convert to final formats could be written up. Not sure if that over-complicates or not. I use `txt2man` to help get manpages started... there may be a version or something similar that will convert from markdown. Not sure.

cmccabe commented

2020-01-31 15:25:40 +00:00

Maintaining segments in markdown that can be combined and converted to the right format seems good to me, and not too complicated.

👍 1

sloum added the

documentation

label 2020-03-11 17:56:37 +00:00

Sign in to join this conversation.