marked-man

WebJar for marked-man

License	MIT
GroupId	org.webjars.npm
ArtifactId	marked-man
Last Version	0.2.1
Release Date	Sep 19, 2017
Type	jar
Description	marked-man WebJar for marked-man
Project URL	http://webjars.org
Source Code Management	https://github.com/kapouer/marked-man

Download marked-man

Filename	Size
marked-man-0.2.1.pom
marked-man-0.2.1.jar	9 KB
marked-man-0.2.1-sources.jar	22 bytes
marked-man-0.2.1-javadoc.jar	22 bytes

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/org.webjars.npm/marked-man/ -->
<dependency>
    <groupId>org.webjars.npm</groupId>
    <artifactId>marked-man</artifactId>
    <version>0.2.1</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/org.webjars.npm/marked-man/
implementation 'org.webjars.npm:marked-man:0.2.1'

Gradle Kotlin

// https://jarcasting.com/artifacts/org.webjars.npm/marked-man/
implementation ("org.webjars.npm:marked-man:0.2.1")

Apache Buildr

'org.webjars.npm:marked-man:jar:0.2.1'

Apache Ivy

<dependency org="org.webjars.npm" name="marked-man" rev="0.2.1">
  <artifact name="marked-man" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='org.webjars.npm', module='marked-man', version='0.2.1')
)

Scala SBT

libraryDependencies += "org.webjars.npm" % "marked-man" % "0.2.1"

Leiningen

[org.webjars.npm/marked-man "0.2.1"]

Dependencies

compile (1)

Group / Artifact	Type	Version
org.webjars.npm : marked	jar	[0.3.2,0.4)

Project Modules

There are no modules declared in this project.

marked-man(1) -- markdown to roff

SYNOPSIS

marked-man README.md > doc/marked-man.1

See marked README for documentation about how to use marked.

Note that marked-man --format=html is the same as marked.

DESCRIPTION

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

OPTIONS

marked-man invokes marked --gfm --sanitize, and you can pass additional options through.
The --breaks option, which retains intra-paragraph line breaks, can be helpful to match default ronn behavior.

marked-man adds some options to marked's existing options:

• --format <format>
  Sets the output format. Outputs html if different from roff.
  Defaults to roff.

• --name <name>
  The name shown in the manpage header, if it isn't given in the ronn header like in this README.
  Defaults to empty string.

• --section <section>
  The section number shown in the manpage header, if it isn't given in the ronn header like in this README.
  Defaults to empty string.

• --version <version>
  The version shown in the manpage footer.
  Defaults to empty string.
  Breaking change in marked-man 0.7.0: this flag is converted to manVersion option, to avoid conflict with marked.

• --manual <manual>
  The manual-group name shown in the manpage header.
  Defaults to empty string.

• --date <date>
  The date shown in the manpage header.
  Defaults to now, must be acceptable to new Date(string or timestamp).

INSTALLATION

From the npm registry:

• locally (--save, --save-dev, or --save-optional add marked-man to your package.json file as a runtime, development-time, or optional runtime dependency, respectively)

    npm install marked-man [--save|--save-dev|--save-optional]
  

• globally (puts marked-man in your system's path):

    [sudo] npm install marked-man -g
  

EXAMPLE

To view this README as a man page, run something like the following:

marked-man --version v0.1.0 --manual 'Man Utilities' README.md | man /dev/stdin

SEE ALSO

Ronn

REPORTING BUGS

See marked-man repository.

Versions

Version
0.2.1 Sep 19, 2017