UziTech / marked-linkify-it

marked using linkify-it for urls
https://www.npmjs.com/package/marked-linkify-it
MIT License
2 stars 4 forks source link
linkify-it marked

marked-linkify-it

marked using linkify-it for urls

Usage

import { marked } from "marked";
import markedLinkifyIt from "marked-linkify-it";

// or UMD script
// <script src="https://cdn.jsdelivr.net/npm/marked/lib/marked.umd.js"></script>
// <script src="https://cdn.jsdelivr.net/npm/marked-linkify-it/lib/index.umd.js"></script>

const schemas = {};
const options = {};

marked.use(markedLinkifyIt(schemas, options));

marked("example.com");
// <p><a href="http://example.com">example.com</a></p>

schemas

see https://github.com/markdown-it/linkify-it#api

Note: #add() doesn't work with this extension

markedLinkifyIt.add('@', {...}) // Doesn't work, you need to pass a schema manually

Instead do:

const schemas = {
    '@': {
        validate: function (text, pos, self) {
            // ...
        },
        normalize: function (match) {
            // ...
        }
    }
};

options

see https://github.com/markdown-it/linkify-it#api

linkify options plus the following additional options:

tlds

String|String[]

replace or add tlds for fuzzy links/

tldsKeepOld

Boolean; Default: false

true to add domains instead of replacing domain list.