https://github.com/wooorm/groff-escape

Unicode characters to Groff commands
https://github.com/wooorm/groff-escape

command escape groff

Last synced: 5 days ago
JSON representation

Unicode characters to Groff commands

• Host: GitHub
• URL: https://github.com/wooorm/groff-escape
• Owner: wooorm
• License: mit
• Created: 2016-08-23T16:57:34.000Z (over 8 years ago)
• Default Branch: main
• Last Pushed: 2023-11-01T11:27:42.000Z (about 1 year ago)
• Last Synced: 2024-12-12T04:41:59.588Z (10 days ago)
• Topics: command, escape, groff
• Language: JavaScript
• Homepage:
• Size: 57.6 KB
• Stars: 2
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md
  • Funding: funding.yml
  • License: license

Awesome Lists containing this project

README

        
# groff-escape

[![Build][build-badge]][build]

[![Coverage][coverage-badge]][coverage]

[![Downloads][downloads-badge]][downloads]

[![Size][size-badge]][size]

Map of non-ASCII characters to Groff commands.

## Contents

*   [What is this?](#what-is-this)

*   [When should I use this?](#when-should-i-use-this)

*   [Install](#install)

*   [Use](#use)

*   [API](#api)

    *   [`groffEscape`](#groffescape)

*   [Types](#types)

*   [Compatibility](#compatibility)

*   [Security](#security)

*   [Related](#related)

*   [Contribute](#contribute)

*   [License](#license)

## What is this?

This package maps non-ASCII characters to Groff commands.

For example, it maps `'≠'` to `'!='` (which you’ll need to wrap like so `\[!=]`

to use in Groff).

## When should I use this?

You can use this package if you’re writing stuff that compiles to Groff / man

pages.

## Install

This package is [ESM only][esm].

In Node.js (version 14.14+, 16.0+), install with [npm][]:

```sh

npm install groff-escape

```

In Deno with [`esm.sh`][esmsh]:

```js

import {groffEscape} from 'https://esm.sh/groff-escape@2'

```

In browsers with [`esm.sh`][esmsh]:

```html

  import {groffEscape} from 'https://esm.sh/groff-escape@2?bundle'

```

## Use

```js

import {groffEscape} from 'groff-escape'

console.log(groffEscape)

```

Yields:

```js

{ '≠': '!=',

  'À': '`A',

  'Á': '\'A',

  'Â': '^A',

  'Ã': '~A',

  // …

  '♥': 'HE',

  '♦': 'DI',

  '✓': 'OK',

  '⟨': 'la',

  '⟩': 'ra' }

```

## API

This package exports the identifier `groffEscape`.

There is no default export.

### `groffEscape`

Map of non-ASCII characters to Groff commands (`Record`).

## Types

This package is fully typed with [TypeScript][].

It exports no additional types.

## Compatibility

This package is at least compatible with all maintained versions of Node.js.

As of now, that is Node.js 14.14+ and 16.0+.

It also works in Deno and modern browsers.

## Security

This package is safe.

## Related

*   [`remarkjs/remark-man`](https://github.com/remarkjs/remark-man)

    — turn markdown into man pages

## Contribute

Yes please!

See [How to Contribute to Open Source][contribute].

## License

[MIT][license] © [Titus Wormer][author]

[build-badge]: https://github.com/wooorm/groff-escape/workflows/main/badge.svg

[build]: https://github.com/wooorm/groff-escape/actions

[coverage-badge]: https://img.shields.io/codecov/c/github/wooorm/groff-escape.svg

[coverage]: https://codecov.io/github/wooorm/groff-escape

[downloads-badge]: https://img.shields.io/npm/dm/groff-escape.svg

[downloads]: https://www.npmjs.com/package/groff-escape

[size-badge]: https://img.shields.io/bundlephobia/minzip/groff-escape.svg

[size]: https://bundlephobia.com/result?p=groff-escape

[npm]: https://docs.npmjs.com/cli/install

[esmsh]: https://esm.sh

[license]: license

[author]: https://wooorm.com

[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c

[typescript]: https://www.typescriptlang.org

[contribute]: https://opensource.guide/how-to-contribute/