DockerCLI/vendor/github.com/cpuguy83/go-md2man
Kir Kolyshkin 6566f5ff2c Bump cpuguy83/go-md2man to v1.0.8
The biggest motivation for this is proper table rendering; in the
old version it was broken so tables were not rendered at al
(i.e. anything that was put into table was lost, for example,
description of LOG_* log levels in dockerd(8) page).

This also fixes lists, including nested lists. This fixes the
description of behavior in docker-cp(1) which is rendered as a tree:

BEFORE:

```
      Assuming a path separator of /, a first argument of SRC_PATH and second
       argument of DEST_PATH, the behavior is as follows:

       · SRC_PATH specifies a file

       · DEST_PATH does not exist

       · the file is saved to a file created at DEST_PATH

       · DEST_PATH does not exist and ends with /

       · Error condition: the destination directory must exist.

...
```

AFTER:
```
      Assuming a path separator of /, a first argument of SRC_PATH and second
       argument of DEST_PATH, the behavior is as follows:

              · SRC_PATH specifies a file

                · DEST_PATH does not exist

                  · the file is saved to a file created at DEST_PATH

                · DEST_PATH does not exist and ends with /

                  · Error condition: the destination directory must exist.

...
```

Manually checking the diff between the man pages generated by the old
and the new version, there are no changes other than the indentation
(.RS/.RE) for lists, and proper formatting for tables. Formatted man
pages also look decent, nothing seems broken.

Signed-off-by: Kir Kolyshkin <kolyshkin@gmail.com>
2018-02-12 12:01:20 -08:00
..
md2man Bump cpuguy83/go-md2man to v1.0.8 2018-02-12 12:01:20 -08:00
LICENSE.md Add missing dependencies to vendor, and fix generation imports 2017-06-02 11:12:43 -04:00
README.md Bump cpuguy83/go-md2man to v1.0.8 2018-02-12 12:01:20 -08:00
md2man.go Bump cpuguy83/go-md2man to v1.0.8 2018-02-12 12:01:20 -08:00

README.md

go-md2man

** Work in Progress ** This still needs a lot of help to be complete, or even usable!

Uses blackfriday to process markdown into man pages.

Usage

./md2man -in /path/to/markdownfile.md -out /manfile/output/path

How to contribute

We use dep for vendoring Go packages. See dep documentation for how to update.

TODO

  • Needs oh so much testing love
  • Look into blackfriday's 2.0 API