Skip to content

sapegin/richtypo.js

Repository files navigation

Richtypo: HTML and Markdown typography enhancer for Node.js

npm Codecov Node.js CI status

Richtypo prepares your texts to publication by improving typography, like fancy quotes ("“”), dashes (-), and adding non-breaking spaces to make the text prettier and more readable by avoiding undesired line breaks.

Richtypo comes with typography rules for English, French, and Russian, and you can customize them and create your own rules — each rule is an independent JavaScript function.

Have a look at the example page and its source.

Features

  • Works with plain text, Markdown, or HTML
  • Uses Unicode characters, doesn’t add any HTML markup by default
  • Takes care of your HTML tags
  • English, French, and Russian rules
  • Run the recommended rules or cherry pick the ones you need
  • Add your own rules
  • Works on the server and in the browser
  • No dependencies

Documentation

Read the docs.

Changelog

The changelog can be found on the Releases page.

Contributing

Bug fixes are welcome, but not new features. Please take a moment to review the contributing guidelines.

Sponsoring

This software has been developed with lots of coffee, buy me one more cup to keep it going.

Buy Me A Coffee

Authors and license

Artem Sapegin and contributors.

MIT License, see the included License.md file. Also see the project status.