Project: retextjs/retext-smartypants

Package: retext-smartypants@5.2.0

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


Build Coverage Downloads Size Sponsors Backers Chat

retext plugin to apply SmartyPants.


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.


This package is ESM only. In Node.js (version 12.20+, 14.14+, 16.0+, or 18.0+), install with npm:

npm install retext-smartypants

In Deno with esm.sh:

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

In browsers with esm.sh:

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


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

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



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


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

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

Apply SmartyPants.


Configuration (optional).


Create smart quotes (boolean, default: true).

Converts straight double and single quotes to smart double or single quotes. The options options.openingQuotes and options.closingQuotes affect which quotes are considered smart.


Characters to use for opening quotes {single: '‘', double: '“'}.


Characters to use for closing quotes {single: '’', double: '”'}.


Create smart ellipses (boolean, default: true).

Converts triple dot characters (with or without spaces) into a single unicode ellipsis character.


Create smart quotes from backticks (boolean or 'all', default: true).

When true, converts double backticks into an opening double quote, and double straight single quotes into a closing double quote.

When 'all': does the what true does with the addition of converting single backticks into an opening single quote, and a straight single quote into a closing single smart quote.

👉 Note: options.quotes can not be true when backticks is 'all'.


Create smart dashes (boolean or 'oldschool', 'inverted', default: true).

When true, converts two dashes into an em dash character.

When 'oldschool', converts two dashes into an en dash, and three dashes into an em dash.

When 'inverted', converts two dashes into an em dash, and three dashes into an en dash.


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


Projects maintained by the unified collective are compatible with all maintained versions of Node.js. As of now, that is Node.js 12.20+, 14.14+, 16.0+, and 18.0+. Our projects sometimes work with older versions, but this is not guaranteed.


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.


MIT © Titus Wormer