# readme-to-man-page

> Convert package readme to a man page

Latest version **0.6.0** (published 2016-01-06) · MIT license · 0 weekly downloads

## Install

```sh
npm install readme-to-man-page
pnpm add readme-to-man-page
yarn add readme-to-man-page
bun add readme-to-man-page
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.6.0 |
| Published | 2016-01-06 |
| First published | 2015-07-14 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 8 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 4 |
| Author | Eugene Sharygin |
| Maintainers | eush77 |
| Keywords | convert, help, man, manpage, manual, markdown, package, page, readme, render, troff, unix |

## Links

- npm: https://www.npmjs.com/package/readme-to-man-page
- Repository: https://github.com/eush77/readme-to-man-page
- Issues: https://github.com/eush77/readme-to-man-page/issues
- npm.io page: https://npm.io/package/readme-to-man-page

## Dependencies (8)

- [remark](https://npm.io/package/remark.md) ^3.1.3
- [remark-man](https://npm.io/package/remark-man.md) ^2.0.1
- [unist-util-remove](https://npm.io/package/unist-util-remove.md) ^0.1.0
- [unist-util-select](https://npm.io/package/unist-util-select.md) ^1.0.0
- [remark-strip-badges](https://npm.io/package/remark-strip-badges.md) ^2.0.0
- [mdast-util-to-string](https://npm.io/package/mdast-util-to-string.md) ^1.0.0
- [remark-normalize-headings](https://npm.io/package/remark-normalize-headings.md) ^0.3.0
- [remark-squeeze-paragraphs](https://npm.io/package/remark-squeeze-paragraphs.md) ^3.0.0

## Alternatives

- [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads
- [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads
- [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads
- [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads
- [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads

## Recent versions

- 0.6.0 (latest) — 2016-01-06
- 0.5.0 — 2015-08-12
- 0.4.1 — 2015-07-25
- 0.4.0 — 2015-07-22
- 0.3.0 — 2015-07-20
- 0.2.2 — 2015-07-16
- 0.2.1 — 2015-07-15
- 0.2.0 — 2015-07-14
- 0.1.0 — 2015-07-14

## README

[![npm](https://nodei.co/npm/readme-to-man-page.png)](https://npmjs.com/package/readme-to-man-page)

# readme-to-man-page

[![Build Status][travis-badge]][travis] [![Dependency Status][david-badge]][david]

Turn Markdown README into a good-looking man page.

Bells and whistles on top of the excellent [remark-man] by [@wooorm].

[@wooorm]: https://github.com/wooorm

[travis]: https://travis-ci.org/eush77/readme-to-man-page
[travis-badge]: https://travis-ci.org/eush77/readme-to-man-page.svg?branch=master
[david]: https://david-dm.org/eush77/readme-to-man-page
[david-badge]: https://david-dm.org/eush77/readme-to-man-page.png

## Example

```js
var readme = fs.readFileSync('./README.md', 'utf8');
var pkg = require('./package');

readmeToManPage(readme, {
  name: pkg.name,
  version: pkg.version,
  description: pkg.description,
  section: 'npm',
  manual: 'Node Package Manager'
})
//=> '.TH "README-TO-MAN-PAGE" "npm" "July 2015" "0.1.2" "Node Package Manager"\n.SH "NAME"\n\\f...'
```

## API

### `readmeToManPage(readme, [opts])`

Returns man page as a string.

#### `readme`

Type: `String` <br>

Readme text in Markdown.

#### Options

No option is required. But the more options are set, the more pleasing the output will be.

- `name` — can be inferred from headings.
- `version`
- `description`
- `date` — latest revision date, passed to `Date` constructor.
- `section` — section code (e.g. `1`).
- `manual` — full section name (e.g. `Linux Programmer's Manual`).

## Related

- [remark-man] — compile Markdown to man pages with [remark].
- [npm-man] — open any package readme from npm as a man page.
- [man-pager] — display a man page in the terminal programmatically.

[remark]: https://github.com/wooorm/remark
[remark-man]: https://github.com/wooorm/remark-man
[npm-man]: https://github.com/eush77/npm-man
[man-pager]: https://github.com/eush77/man-pager

## Install

```
npm install readme-to-man-page
```

## License

MIT

---
_Source: https://npm.io/package/readme-to-man-page · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._