logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

marked-man - markdown to roff

As Marked Extension

         import markedMan from 'marked-man';
         import marked from 'marked';

         marked.use(markedMan);

Description

marked-man wraps marked to extend it with groff output support in order to
       create Unix manual pages for use with man.

       It follows the ronn markdown level-1 header format:
       # name(section) -- short description

       which populates the HEADER section, and the NAME section (if none is already written) of the manpage.

Example

       To view this README as a man page, run something like the following:
         marked-man README.md | man /dev/stdin

Installation

       See your node package manager manual...

       For example:
         npx marked-man simple.md

Name

marked-man - markdown to roff

Options

marked-man is a marked CLI extension, meaning options can be passed directly to marked.

       The  --breaks  option, which retains intra-paragraph line breaks, is now true by default. Use --no-breaks
       to disable it.

       marked-man adds some options to marked's existing options, to be able to override  the  header/footer  of
       generated man pages.

        • --name<name>
          Optional, overrides name in ronn header.

        • --section<section>
          Optional, overrides section in ronn header. Defaults to 1.

        • --description<description>
          Optional, overrides description in ronn header.

        • --version<version>
          The version shown in the manpage footer.
          Optional, when omitted, defaults to the target node module version, or empty.

        • --manual<manual>
          The manual-group name shown in the manpage header.
          Optional, when omitted, man displays a value matching the section.

        • --date<date>
          The date shown in the manpage header.
          Optional, defaults to now.
          Must be acceptable to newDate(stringortimestamp).
          Honors SOURCE_DATE_EPOCH environment variable for reproducible builds.

Reporting Bugs

       See marked-manrepository.

1.3.6                                              April 2024                                      MARKED-MAN(1)

See Also

RonnRonn-NGgroff

Synopsis

         marked-man README.md > doc/foo.1
         # works too with stdin
         cat README.md | marked-man --version 1.0 | man /dev/stdin

       See also markeddocumentation.

See Also