markdown-it-attr-typographer v1.0.1

markdown-it-attr-typographer

Enable markdown-it typographer mode on text attributes.

Overview

markdown-it comes with a typographer options allowing for smart quotes and various replacements.

But it only applies those replacements on text nodes, not attributes. If you want to have the typographer mode applied to text attributes, like title and alt, this plugin is for you!

Usage

const md = require('markdown-it')({ typographer: true })
  .use(require('markdown-it-attr-typographer'), opts)

The opts object can contain:

Example

This source Markdown:

# Title <small>[link](/whatever "With it's title(tm)")</small>

Some ![Image(tm) with "quotes"](/whatever "With it's title(tm)")

Will be rendered as:

<h1>Title <small><a href="/whatever" title="With it’s title™">link</a></small></h1>
<p>Some <img src="/whatever" alt="Image™ with “quotes”" title="With it’s title™"></p>

Additionally, with { html: true }, it will enable:

Some <abbr title='Abbreviation(tm) with "quotes"'>*AWQ(tm)*</abbr>

<figure class="whatever">
  <img alt='Image(tm) with "quotes"' title=Hello(tm) src="/whatever">
</figure>

Some <a href="/link" title="With &quot;quoted&quot; title(tm)">link</a>

To be rendered as:

<p>Some <abbr title='Abbreviation™ with “quotes”'><em>AWQ™</em></abbr></p>
<figure class="whatever">
  <img alt='Image™ with “quotes”' title=Hello™ src="/whatever">
</figure>
<p>Some <a href="/link" title="With “quoted” title™">link</a></p>

Apply typographer transforms to anything

If you want to have an easily accessible function to apply markdown-it's typographer transforms on any string, you can also use this plugin for this.

const md = require('markdown-it')({ typographer: true })
  .use(require('markdown-it-attr-typographer'))

// This will only process the text if the `typographer` option is set to `true`.
md.typographer(`Some "text" --- that's coming with various transforms(c)`)

Additionally, if you want to apply markdown-it typography to any string regardless of the state of your markdown-it instance (or without actually using markdown-it), you can use the global function.

const { typographer } = require('markdown-it-attr-typographer')

// This will always transform the text.
typographer(`Some "text" --- that's coming with various transforms(c)`)

You can pass markdown-it options as second argument, e.g. for French style quotes:

md.typographer(`Some "text" --- that's coming with various transforms(c)`, {
  quotes: ['«\xA0', '\xA0»', '‹\xA0', '\xA0›']
})