kiwa-hyphenizer
    TypeScript icon, indicating that this package has built-in type declarations

    0.0.1 • Public • Published

    Codacy Badge npm version

    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 $ yarn add kiwa-hyphenizer.

    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.

    Keywords

    none

    Install

    npm i kiwa-hyphenizer

    DownloadsWeekly Downloads

    54

    Version

    0.0.1

    License

    MIT

    Unpacked Size

    11.7 kB

    Total Files

    14

    Last publish

    Collaborators

    • tobiaskoengeter