remark-underline's Introduction

remark-underline

A remark plugin that adds support for underlining. By default this is done by repurposing __ from the bold formatter. Bold also supports ** so repurposing __ is a popular choice for underlining text.

Installation

npm install remark-underline

For best results you should use remark-html or similar.

Usage

Import the plugin and then pass it into remark or your unified processor chain.

import remark from 'remark';
import html from 'remark-html';
import underline from 'remark-underline';

remark.use(html).use(underline).process("__hello world__");

With the plugin the output will be

<p>
  <ins class="underline">hello world</ins>
</p>

Without the plugin the output will be

<p>
  <strong>hello world</strong>
</p>

Options

You may supply an optional options object to configure the plugin. These are the options currently supported.

marker - The token used to identify unerlined text. By default this is '__'.
nodeType - The name of the node to create. By default this is 'underline'.
tagType - The name of the HTML tag to wrap the text in. The default is 'ins' however this may not always be appropriate.
classNames - An array of class names to use for the HTML tag. By default this is just 'underline'. Passing an empty array will disable this.

Example

    const underlineOptions = {
        marker: '!!',
        classNames: ['thing1', 'thing2']
    }

    remark().use(html).use(underline, underlineOptions).process("!!I Am Underline!!");