npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

markdown-man

v0.1.6

Published

wrapper adding manpage output to 'markedown', inspired by 'ronn'

Downloads

19

Readme

markdown-man(1) -- markdown to roff

SYNOPSIS

markdown-man README.md > doc/foo.1
# works too with stdin
cat README.md | markdown-man --version 1.0 | man /dev/stdin

DESCRIPTION

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

It follows the ronn markdown level-1 header format: # name(section) -- short description

which populates the HEADER section, and the NAME section (if none is already written) of the manpage.

OPTIONS

markdown-man is a marked CLI extension, meaning options can be passed directly to marked.

The --breaks option, which retains intra-paragraph line breaks, is now true by default. Use --no-breaks to disable it.

markdown-man adds some options to marked's existing options, to be able to override the header/footer of generated man pages.

  • --name <name> Optional, overrides name in ronn header.

  • --section <section> Optional, overrides section in ronn header. Defaults to 1.

  • --description <description> Optional, overrides description in ronn header.

  • --version <version> The version shown in the manpage footer. Optional, when omitted, defaults to the target node module version, or empty.

  • --manual <manual> The manual-group name shown in the manpage header. Optional, when omitted, man displays a value matching the section.

  • --date <date> The date shown in the manpage header. Optional, defaults to now. Must be acceptable to new Date(string or timestamp). Honors SOURCE_DATE_EPOCH environment variable for reproducible builds.

INSTALLATION

See your node package manager manual...

For example:

npx markdown-man simple.md

EXAMPLE

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

markdown-man README.md | man /dev/stdin

AS MARKED EXTENSION

import markedMan from 'markdown-man';
import marked from 'marked';

marked.use(markedMan);

SEE ALSO

Ronn Ronn-NG groff

REPORTING BUGS

See markdown-man repository.