2017-06-02 10:54:54 -04:00
|
|
|
package md2man
|
|
|
|
|
|
|
|
|
|
import (
|
|
|
|
|
"github.com/russross/blackfriday"
|
|
|
|
|
)
|
|
|
|
|
|
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 14:41:18 -05:00
|
|
|
// Render converts a markdown document into a roff formatted document.
|
2017-06-02 10:54:54 -04:00
|
|
|
func Render(doc []byte) []byte {
|
|
|
|
|
renderer := RoffRenderer(0)
|
|
|
|
|
extensions := 0
|
|
|
|
|
extensions |= blackfriday.EXTENSION_NO_INTRA_EMPHASIS
|
|
|
|
|
extensions |= blackfriday.EXTENSION_TABLES
|
|
|
|
|
extensions |= blackfriday.EXTENSION_FENCED_CODE
|
|
|
|
|
extensions |= blackfriday.EXTENSION_AUTOLINK
|
|
|
|
|
extensions |= blackfriday.EXTENSION_SPACE_HEADERS
|
|
|
|
|
extensions |= blackfriday.EXTENSION_FOOTNOTES
|
|
|
|
|
extensions |= blackfriday.EXTENSION_TITLEBLOCK
|
|
|
|
|
|
|
|
|
|
return blackfriday.Markdown(doc, renderer, extensions)
|
|
|
|
|
}
|
