<commit_before>[![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 to a good-looking man page.

[travis]: https://travis-ci.org/eush77/readme-to-man-page
[travis-badge]: https://travis-ci.org/eush77/readme-to-man-page.svg
[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,<commit_msg>(readme) Track master on Travis<commit_after>[![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 to a good-looking man page.

[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,
{'fraction_non_alphanumeric': 0.21120689655172414, 'fraction_numerical': 0.01293103448275862, 'mean_word_length': 4.780082987551867, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 12, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '6972778', 'n_tokens_mistral': 592, 'n_tokens_neox': 576, 'n_words': 71}