Kramdown Man Versions Save

Allows you to write man pages in pure markdown.

v1.0.1

5 months ago
  • Treat markdown code-fence kd:codespans the same as kd:codeblocks.

      ```
      puts "hello world"
      ```
    
    puts "hello world"
    

v1.0.0

5 months ago
  • Ignore kd:blank elements to reduce size of generated man pages.
  • No longer output .HP paragraphs due to cross-platform compatibility issues with groff, nroff, troff.
  • Renamed Kramdown::Converters::Man to {Kramdown::Man::Converter}.
  • Override {Kramdown::Document#to_man} to use our {Kramdown::Man::Converter}.

Syntax

  • Added support for definition lists.

  • Switched to using definition lists for documenting options and arguments.

    ## ARGUMENTS
    
    *ARG*
    : Description goes here.
    
    ...
    
    ## OPTIONS
    
    `-o`, `--option` *VALUE
    : Description goes here.
    
    ...
    
  • Added support for rendering relative links to other markdown man pages as SEE ALSO man page references.

    Example:

    [foo-bar](foo-bar.1.md)
    

    Will be converted into:

    foo-bar(1)
    
  • Ignore horizontal rule elements due to cross-platform compatibility issues with groff, nroff, troff.

CLI

  • Added the -o, --output FILE option.
  • Added the -V, --version option.
  • Display the kramdown-man.1 man page when --help is given, if STDOUT is a TTY. If STDOUT is not a TTY, then the usual --help information will be printed.