A remark plugin integrating Typopo to automatically fix frequent microtypographical errors in Markdown text.

This package integrates Typopo, a microtypography correction library created by Braňo Šandala, into remark, a Markdown processor. Typopo corrects punctuation, whitespace, symbols, and other typographical details, ensuring professional-quality typography. Typopo supports multiple languages including English, German, Slovak, Czech, and Rusyn.

While plugins like remark-smartypants provide basic typographical enhancements, Typopo offers more comprehensive language-specific fixes and robust handling of microtypography errors. For example:

Typopo fixes:

• Dashes and hyphens
• Quotes (single, double, primes)
• Ellipsis
• Symbols (multiplication signs, section signs, copyright symbols, trademarks, etc.)
• Whitespace issues (non-breaking spaces, extra spaces, empty lines)
• Common punctuation errors
• And much more…

npm install remark-typopo

import { unified } from 'unified';
import remarkParse from 'remark-parse';
import remarkTypopo from 'remark-typopo';
import remarkStringify from 'remark-stringify';

const markdown = '"Hello" --- world!';

const processed = await unified()
  .use(remarkParse)
  .use(remarkTypopo, { locale: 'en-us' })
  .use(remarkStringify)
  .process(markdown);

console.log(String(processed));
// => “Hello” — world!

In Astro projects, you may want to set smartypants to false in your astro.config.mjs or astro.config.mts to avoid potential conflicts.

// astro.config.mjs
import { defineConfig } from 'astro/config';
import remarkTypopo from 'remark-typopo';

export default defineConfig({
  markdown: {
    smartypants: false,  // Turn off built-in smartypants
    remarkPlugins: [
      [remarkTypopo, { locale: 'en-us' }],
    ],
  },
});

The following options are available:

The following original Typopo options are incompatible with this remark integration and are thus deprecated:

• removeLines
• removeWhitespacesBeforeMarkdownList
• keepMarkdownCodeBlocks

Attempting to use these will have no effect or produce unintended side effects.

MIT