search

mity / md4c

C Markdown parser. Fast. SAX-like interface. Compliant to CommonMark specification.
MIT License
759 stars 140 forks source link

md2html does not have man page #56

Closed mity closed 5 years ago

mity commented 5 years ago

As MD4C is currently being added into some Linux distros (see #48 or #55), md2html tool should have a better documentation, in particular man page.

mity commented 5 years ago

Anyone with decent English is welcome to help.

craigbarnes commented 5 years ago

I noticed you commented in another issue:

I am not sure I want to get feature requests for implementing all possible output formats

Does this mean you'd prefer not to have a roff renderer and md2man tool contributed along with the man pages? I'd be willing to send a PR for adding man page(s) either way, but generating them from a simpler format is usually much nicer than editing roff files by hand.

mity commented 5 years ago

I am not sure I want to get feature requests for implementing all possible output formats

I think my point of view has shifted somewhat since then. The main motivation for that comment originally was that I was not ready to solve the stabilization of the parser API and addition of such plugins at the same time.

But today I think we have actually reached that stage: Even the HTML renderer is likely going to become part of the official API (see #82). So I am now much more open to such idea also for other other output formats.

EDIT: Please for any further discussion about that open a new PR or new issue, so this thread is kept for missing man page as such, even it might be related as it would allow us to later generate it by our own toolset which would be naturally cool thing.

craigbarnes commented 5 years ago

@mity I've submitted a (hand-written) man page in #85.