ChangeLog.md in kramdown-man-0.1.9 vs ChangeLog.md in kramdown-man-1.0.0

- old
+ new

@@ -1,4 +1,59 @@ +### 1.0.0 / 2023-12-03 + +* 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. + + ```markdown + ## ARGUMENTS + + *ARG* + : Description goes here. + + ... + ``` + + ```markdown + ## 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: + + ```markdown + [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. + ### 0.1.9 / 2023-12-01 * Allow markdown `man:file.ext` style links, since man pages can be named after file names (ex: `shard.yml`). * Use the `.PP` roff macro instead of the deprecated `.HP` macro.