{"id":15413459,"url":"https://github.com/wooorm/groff-escape","last_synced_at":"2025-04-19T11:40:08.794Z","repository":{"id":57254341,"uuid":"66386203","full_name":"wooorm/groff-escape","owner":"wooorm","description":"Unicode characters to Groff commands","archived":false,"fork":false,"pushed_at":"2023-11-01T11:27:42.000Z","size":59,"stargazers_count":2,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-29T07:22:35.236Z","etag":null,"topics":["command","escape","groff"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/wooorm.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":"funding.yml","license":"license","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":"wooorm"}},"created_at":"2016-08-23T16:57:34.000Z","updated_at":"2023-10-29T11:02:59.000Z","dependencies_parsed_at":"2024-06-20T18:58:15.552Z","dependency_job_id":"c11da452-addb-47a2-9a06-0d7ca10aec9a","html_url":"https://github.com/wooorm/groff-escape","commit_stats":{"total_commits":56,"total_committers":1,"mean_commits":56.0,"dds":0.0,"last_synced_commit":"5d1b06999465f9687b251aa18d4f4ff0361db9da"},"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wooorm%2Fgroff-escape","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wooorm%2Fgroff-escape/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wooorm%2Fgroff-escape/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wooorm%2Fgroff-escape/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/wooorm","download_url":"https://codeload.github.com/wooorm/groff-escape/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249522487,"owners_count":21285495,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["command","escape","groff"],"created_at":"2024-10-01T16:57:11.054Z","updated_at":"2025-04-19T11:40:08.753Z","avatar_url":"https://github.com/wooorm.png","language":"JavaScript","funding_links":["https://github.com/sponsors/wooorm"],"categories":[],"sub_categories":[],"readme":"# groff-escape\n\n[![Build][build-badge]][build]\n[![Coverage][coverage-badge]][coverage]\n[![Downloads][downloads-badge]][downloads]\n[![Size][size-badge]][size]\n\nMap of non-ASCII characters to Groff commands.\n\n## Contents\n\n*   [What is this?](#what-is-this)\n*   [When should I use this?](#when-should-i-use-this)\n*   [Install](#install)\n*   [Use](#use)\n*   [API](#api)\n    *   [`groffEscape`](#groffescape)\n*   [Types](#types)\n*   [Compatibility](#compatibility)\n*   [Security](#security)\n*   [Related](#related)\n*   [Contribute](#contribute)\n*   [License](#license)\n\n## What is this?\n\nThis package maps non-ASCII characters to Groff commands.\nFor example, it maps `'≠'` to `'!='` (which you’ll need to wrap like so `\\[!=]`\nto use in Groff).\n\n## When should I use this?\n\nYou can use this package if you’re writing stuff that compiles to Groff / man\npages.\n\n## Install\n\nThis package is [ESM only][esm].\nIn Node.js (version 14.14+, 16.0+), install with [npm][]:\n\n```sh\nnpm install groff-escape\n```\n\nIn Deno with [`esm.sh`][esmsh]:\n\n```js\nimport {groffEscape} from 'https://esm.sh/groff-escape@2'\n```\n\nIn browsers with [`esm.sh`][esmsh]:\n\n```html\n\u003cscript type=\"module\"\u003e\n  import {groffEscape} from 'https://esm.sh/groff-escape@2?bundle'\n\u003c/script\u003e\n```\n\n## Use\n\n```js\nimport {groffEscape} from 'groff-escape'\n\nconsole.log(groffEscape)\n```\n\nYields:\n\n```js\n{ '≠': '!=',\n  'À': '`A',\n  'Á': '\\'A',\n  'Â': '^A',\n  'Ã': '~A',\n  // …\n  '♥': 'HE',\n  '♦': 'DI',\n  '✓': 'OK',\n  '⟨': 'la',\n  '⟩': 'ra' }\n```\n\n## API\n\nThis package exports the identifier `groffEscape`.\nThere is no default export.\n\n### `groffEscape`\n\nMap of non-ASCII characters to Groff commands (`Record\u003cstring, string\u003e`).\n\n## Types\n\nThis package is fully typed with [TypeScript][].\nIt exports no additional types.\n\n## Compatibility\n\nThis package is at least compatible with all maintained versions of Node.js.\nAs of now, that is Node.js 14.14+ and 16.0+.\nIt also works in Deno and modern browsers.\n\n## Security\n\nThis package is safe.\n\n## Related\n\n*   [`remarkjs/remark-man`](https://github.com/remarkjs/remark-man)\n    — turn markdown into man pages\n\n## Contribute\n\nYes please!\nSee [How to Contribute to Open Source][contribute].\n\n## License\n\n[MIT][license] © [Titus Wormer][author]\n\n\u003c!-- Definitions --\u003e\n\n[build-badge]: https://github.com/wooorm/groff-escape/workflows/main/badge.svg\n\n[build]: https://github.com/wooorm/groff-escape/actions\n\n[coverage-badge]: https://img.shields.io/codecov/c/github/wooorm/groff-escape.svg\n\n[coverage]: https://codecov.io/github/wooorm/groff-escape\n\n[downloads-badge]: https://img.shields.io/npm/dm/groff-escape.svg\n\n[downloads]: https://www.npmjs.com/package/groff-escape\n\n[size-badge]: https://img.shields.io/bundlephobia/minzip/groff-escape.svg\n\n[size]: https://bundlephobia.com/result?p=groff-escape\n\n[npm]: https://docs.npmjs.com/cli/install\n\n[esmsh]: https://esm.sh\n\n[license]: license\n\n[author]: https://wooorm.com\n\n[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c\n\n[typescript]: https://www.typescriptlang.org\n\n[contribute]: https://opensource.guide/how-to-contribute/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwooorm%2Fgroff-escape","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwooorm%2Fgroff-escape","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwooorm%2Fgroff-escape/lists"}