remark-hypher
A remark plugin that implements hyphenation using Hypher.
Getting Started
npm i --save remark-hypher
const content = console // "Very long sentence"
Options
remark-hypher
takes all of the options exposed by Hypher itself, as well as 2 more options, language
and minLength
.
const content =
The default language object used is hyphenation.en-us
, which you can see the settings for here.
language
allows you to specify a custom language object. You may choose one from hyphenation-patterns, or supply your own.
leftmin
, rightmin
, exceptions
, and patterns
, if specified, will take precedence over the settings in the language object.
minLength
has a default value of 4.
Why?
Even though CSS has a hyphens
rule, it lacks the ability to finetune the hyphenation behaviour, letting the browser decide how best to hyphenate. For most people, this default behaviour may be sufficient.
For those who desire more fine-grained hyphenation behaviour, specifically around being able to tweak settings on minimum hyphenation length, minimum hyphenation length before/after the line break, or adding exceptions, hypher
allows one to do that.
There are CSS proposals in the pipeline for specifying some of these, but until we get there, hypher
will do the job nicely.
Credits
Of course, most of the hard work is due to Hypher.