Security News
JavaScript Leaders Demand Oracle Release the JavaScript Trademark
In an open letter, JavaScript community leaders urge Oracle to give up the JavaScript trademark, arguing that it has been effectively abandoned through nonuse.
micromark-extension-gfm-autolink-literal
Advanced tools
micromark extension to support GFM autolink literals
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.
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 'support@example.com' is converted into a clickable mailto link.
const micromark = require('micromark');
const gfmAutolinkLiteral = require('micromark-extension-gfm-autolink-literal');
const input = 'Contact us at support@example.com.';
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);
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.
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.
micromark extension to support GitHub flavored markdown (GFM) literal autolinks.
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.
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.
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>
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>
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
).
This package is fully typed with TypeScript. There are no additional exported types.
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.
This package is safe.
syntax-tree/mdast-util-gfm-autolink-literal
— support GFM autolink literals in mdastsyntax-tree/mdast-util-gfm
— support GFM in mdastremarkjs/remark-gfm
— support GFM in remarkSee 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.
FAQs
micromark extension to support GFM autolink literals
The npm package micromark-extension-gfm-autolink-literal receives a total of 2,215,860 weekly downloads. As such, micromark-extension-gfm-autolink-literal popularity was classified as popular.
We found that micromark-extension-gfm-autolink-literal demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
In an open letter, JavaScript community leaders urge Oracle to give up the JavaScript trademark, arguing that it has been effectively abandoned through nonuse.
Security News
The initial version of the Socket Python SDK is now on PyPI, enabling developers to more easily interact with the Socket REST API in Python projects.
Security News
Floating dependency ranges in npm can introduce instability and security risks into your project by allowing unverified or incompatible versions to be installed automatically, leading to unpredictable behavior and potential conflicts.