micromark-extension-gfm-autolink-literal

micromark extension to support GitHub flavored markdown (GFM) literal autolinks.

What is this?

This package is a micromark extension to add support for GFM literal autolinks.

GitHub employs different algorithms to autolink: one at parse time and one at transform time (similar to how @mentions are done at transform 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 second algorithm is performed by mdast-util-gfm-autolink-literal. The html part of this micromark extension does not operate on an AST and hence can’t perform the second algorithm.

When to use this

In many cases, when working with micromark, you’d want to use micromark-extension-gfm instead, which combines this package with other GFM features.

When working with syntax trees, you’d want to combine this package with mdast-util-gfm-autolink-literal (or mdast-util-gfm when using micromark-extension-gfm).

These tools are all rather low-level. In most cases, you’d instead want to use remark-gfm with remark.

Install

This package is ESM only. In Node.js (version 12.20+, 14.14+, or 16.0+), install with npm:

npm install micromark-extension-gfm-autolink-literal

In Deno with Skypack:

import {gfmAutolinkLiteral, gfmAutolinkLiteralHtml} from 'https://cdn.skypack.dev/micromark-extension-gfm-autolink-literal@1?dts'

In browsers with Skypack:

<script type="module">
  import {gfmAutolinkLiteral, gfmAutolinkLiteralHtml} from 'https://cdn.skypack.dev/micromark-extension-gfm-autolink-literal@1?min'
</script>

Use

import {micromark} from 'micromark'
import {
  gfmAutolinkLiteral,
  gfmAutolinkLiteralHtml
} from 'micromark-extension-gfm-autolink-literal'

const output = micromark('Just a URL: www.example.com.', {
  extensions: [gfmAutolinkLiteral],
  htmlExtensions: [gfmAutolinkLiteralHtml]
})

console.log(output)

Yields:

<p>Just a URL: <a href="http://www.example.com">www.example.com</a>.</p>

API

This package exports the following identifiers: gfmAutolinkLiteral, gfmAutolinkLiteralHtml. There is no default export.

The export map supports the endorsed development condition. Run node --conditions development module.js to get instrumented dev code. Without this condition, production code is loaded.

`gfmAutolinkLiteral`

An extension for micromark to parse GFM autolink literals (can be passed in extensions).

`gfmAutolinkLiteralHtml`

An extension to compile them to HTML (can be passed in htmlExtensions).

Types

This package is fully typed with TypeScript. There are no additional exported types.

Compatibility

This package is at least compatible with all maintained versions of Node.js. As of now, that is Node.js 12.20+, 14.14+, and 16.0+. It also works in Deno and modern browsers.

Security

This package is safe.

syntax-tree/mdast-util-gfm-autolink-literal — support GFM autolink literals in mdast
syntax-tree/mdast-util-gfm — support GFM in mdast
remarkjs/remark-gfm — support GFM in remark

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.

npm