kiwa-hyphenizer v0.2.0

Kiwa Hyphenizer

Perfect hyphenation for your Website.

Installation

This library is made for the use with Node. Add it to your project by running $ npm install kiwa-hyphenizer or add it with another dependency manager by your choice.

Usage

Set up the hyphenation like that:

import { Hyphenation } from "kiwa-hyphenizer";

const hyphenatedWords = {
    "Silbentrennung": "Silben|trennung"    
};

const hyphenation = new Hyphenation(hyphenatedWords);

hyphenation.addElements([
    ...document.querySelectorAll("h1"),
    ...document.querySelectorAll("p")
]);

Fetching hyphenated words

You can fetch hyphenated versions of your words from the Hyphenizer API automatically. Please note that the Hyphenizer API requires you to have a valid API token.

Help

If you have any questions, feel free to contact us under hello@bitandblack.com.

Further information about Bit&Black can be found under www.bitandblack.com.