Skip to content

UziTech/marked-linkify-it

Repository files navigation

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 options = {
  // see options below
};

const marked = new Marked();
marked.use(markedLinkifyIt(options));
marked.parse("example.com");
// <p><a href="http://example.com">example.com</a></p>

options

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

All linkify-it options plus the following additional options:

fuzzyLink

Boolean; Default: true

true to enable recognition of URLs without schema (e.g. example.com). Note that this differs from linkify-it's default of false.

tlds

String|String[]; Default: undefined

A list of TLDs (top-level domains) to add or replace in the domain list.

tldsKeepOld

Boolean; Default: false

true to add domains in tlds option instead of replacing domain list.

schemas

Object; Default: undefined

A map of schemas to add to linkify-it. linkify-it supports http(s)://... , ftp://..., mailto:... & //... links by default.

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

About

marked using linkify-it for urls

Topics

Resources

License

Stars

3 stars

Watchers

1 watching

Forks

Packages

 
 
 

Contributors