micromark-extension-gfm-autolink-literal

What is micromark-extension-gfm-autolink-literal?

The micromark-extension-gfm-autolink-literal package is an extension for micromark that provides support for GitHub Flavored Markdown (GFM) autolink literals. This means it can automatically convert URLs, email addresses, and other literal links into clickable links in Markdown content.

What are micromark-extension-gfm-autolink-literal's main functionalities?

Autolink URLs

This feature automatically converts plain URLs into clickable links. In the example, the URL 'https://example.com' is converted into a clickable link.

const micromark = require('micromark');
const gfmAutolinkLiteral = require('micromark-extension-gfm-autolink-literal');

const input = 'Check out https://example.com for more info.';
const output = micromark(input, { extensions: [gfmAutolinkLiteral()] });
console.log(output);

Autolink Email Addresses

This feature automatically converts plain email addresses into clickable mailto links. In the example, the email address '[e-mail]' is converted into a clickable mailto link.

const micromark = require('micromark');
const gfmAutolinkLiteral = require('micromark-extension-gfm-autolink-literal');

const input = 'Contact us at [e-mail].';
const output = micromark(input, { extensions: [gfmAutolinkLiteral()] });
console.log(output);

Autolink www-prefixed URLs

This feature automatically converts www-prefixed URLs into clickable links. In the example, the URL 'www.example.com' is converted into a clickable link.

const micromark = require('micromark');
const gfmAutolinkLiteral = require('micromark-extension-gfm-autolink-literal');

const input = 'Visit www.example.com for details.';
const output = micromark(input, { extensions: [gfmAutolinkLiteral()] });
console.log(output);

Other packages similar to micromark-extension-gfm-autolink-literal

remark-autolink-headings

The remark-autolink-headings package is a plugin for remark that automatically adds links to headings in Markdown content. While it focuses on headings rather than literal links, it provides similar functionality in terms of enhancing Markdown content with automatic links.

markdown-it-implicit-figures

The markdown-it-implicit-figures package is a plugin for markdown-it that automatically wraps images in <figure> tags. While it doesn't focus on autolinking, it provides similar automatic enhancements to Markdown content.

README

micromark-extension-gfm-autolink-literal

micromark extension to support GitHub flavored markdown literal autolinks.

This syntax extension matches the GFM spec and how literal autolinks work in several places on github.com. Do note that GH employs two algorithms to autolink: one at parse time, one at compile time (similar to how @mentions are done at compile time). This difference can be observed because character references and escapes are handled differently. But also because issues/PRs/comments omit (perhaps by accident?) the second algorithm for www., http://, and https:// links (but not for email links).

As this is a syntax extension, it focuses on the first algorithm. The html part of this extension does not operate on an AST and hence can’t perform the second algorithm. mdast-util-gfm-autolink-literal adds support for the second.

This package provides the low-level modules for integrating with the micromark tokenizer and the micromark HTML compiler.

You probably should use this package with mdast-util-gfm-autolink-literal.

Install

npm:

npm install micromark-extension-gfm-autolink-literal

API

html

syntax

Note: syntax is the default export of this module, html is available at micromark-extension-gfm-autolink-literal/html.

Support literal autolinks. The exports are extensions for the micromark parser (to tokenize; can be passed in extensions) and the default HTML compiler (to compile as <a> elements; can be passed in htmlExtensions).

Related

• remarkjs/remark — markdown processor powered by plugins
• micromark/micromark — the smallest commonmark-compliant markdown parser that exists
• syntax-tree/mdast-util-gfm-autolink-literal — mdast utility to support autolink literals
• syntax-tree/mdast-util-from-markdown — mdast parser using micromark to create mdast from markdown
• syntax-tree/mdast-util-to-markdown — mdast serializer to create markdown from mdast

Contribute

See contributing.md in micromark/.github for ways to get started. See support.md for ways to get help.

This project has a code of conduct. By interacting with this repository, organization, or community you agree to abide by its terms.

License

MIT © Titus Wormer