# manon

> Manual page render

Latest version **0.2.2** (published 2021-07-26) · 0 weekly downloads

## Install

```sh
npm install manon
pnpm add manon
yarn add manon
bun add manon
```

## 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.2.2 |
| Published | 2021-07-26 |
| First published | 2021-03-02 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 22.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | YounGoat |
| Maintainers | youngoat |
| Keywords | man, manual-page |

## Links

- npm: https://www.npmjs.com/package/manon
- Repository: https://github.com/YounGoat/nodejs.manon
- Issues: https://github.com/YounGoat/nodejs.manon/issues
- npm.io page: https://npm.io/package/manon

## Dependencies (3)

- [if2](https://npm.io/package/if2.md) ^0.2.0
- [noda](https://npm.io/package/noda.md) ^0.6.0
- [colors](https://npm.io/package/colors.md) ^1.4.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.2.2 (latest) — 2021-07-26
- 0.2.1 — 2021-07-26
- 0.2.0 — 2021-04-14
- 0.1.1 — 2021-03-04
- 0.1.0 — 2021-03-04
- 0.0.1 — 2021-03-02

## README

#	manon
__Manual page render__

Parse manual page text and render in more friendly style.

##	Table of contents

*	[Get Started](#get-started)
*	[API](#api)
* 	[Examples](#examples)

##	Links

*	[CHANGE LOG](./CHANGELOG.md)
*	[Homepage](https://github.com/YounGoat/nodejs.manon)

##	Get Started

```javascript
const manon = require('manon');

// Return formatted text.
let richText = manon.format(manualText, 'console');

// Send to standard output.
process.stdout.write(richText);
```

Manual text rendered by *manon* may look like:
![formatted](docs/photos/formatted.png)
 
While the original text looks like:
![text](docs/photos/text.png)

##  Examples

Here is an [example of *manualText*](./example/help.txt).

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