unified

Project: retextjs/retext-smartypants

Package: retext-smartypants@5.2.0

  1. Dependents: 0
  2. retext plugin to implement SmartyPants
  1. unified 181
  2. retext 42
  3. retext-plugin 26
  4. typography 3

retext-smartypants

Build Coverage Downloads Size Sponsors Backers Chat

retext plugin to apply SmartyPants.

Contents

What is this?

This package is a unified (retext) plugin to apply SmartyPants to the syntax tree. It replaces straight/typewriter punctuation marks and symbols with smart/curly marks and symbols.

When should I use this?

You can use this plugin any time there straight marks and symbols in prose, but you want to use smart ones instead.

Install

This package is ESM only. In Node.js (version 16+), install with npm:

npm install retext-smartypants

In Deno with esm.sh:

import retextSmartypants from 'https://esm.sh/retext-smartypants@6'

In browsers with esm.sh:

<script type="module">
  import retextSmartypants from 'https://esm.sh/retext-smartypants@6?bundle'
</script>

Use

import {retext} from 'retext'
import retextSmartypants from 'retext-smartypants'

const file = await retext()
  .use(retextSmartypants)
  .process('He said, "A \'simple\' english sentence. . ."')

console.log(String(file))

Yields:

He said, “A ‘simple’ english sentence…”

API

This package exports no identifiers. The default export is retextSmartypants.

unified().use(retextSmartypants[, options])

Replace straight punctuation marks with curly ones.

Parameters
Returns

Transform (Transformer).

Options

Configuration (TypeScript type).

Fields

QuoteCharacterMap

Quote characters (TypeScript type).

Fields

Types

This package is fully typed with TypeScript. It exports the additional types Options and QuoteCharacterMap.

Compatibility

Projects maintained by the unified collective are compatible with maintained versions of Node.js.

When we cut a new major release, we drop support for unmaintained versions of Node. This means we try to keep the current release line, retext-smartypants@^6, compatible with Node.js 16.

Contribute

See contributing.md in retextjs/.github for ways to get started. See support.md for ways to get help.

This project has a code of conduct. By interacting with this repository, organization, or community you agree to abide by its terms.

License

MIT © Titus Wormer