remark-github

12.0.0 • Public • Published2 years ago

remark-github

remark plugin to link references to commits, issues, and users, in thesame way that GitHub does in comments, issues, PRs, and releases (seeWritingon GitHub).

What is this?

This package is aunified (remark) plugin to link references to commits,issues, and users:@wooorm ->[**@wooorm**](https://github.com/wooorm).

This project is useful if you want to emulate how markdown would work in GitHubcomments, issues, PRs, or releases, but it’s actually displayed somewhere else(on a website, or in other places on GitHub which don’t link references, such asmarkdown in a repo or Gist).This plugin does not support other platforms such as GitLab or Bitbucket andtheir custom features.

A different plugin,remark-gfm, adds support for GFM (GitHubFlavored Markdown).GFM is a set of extensions (autolink literals, footnotes, strikethrough, tables,and tasklists) to markdown that are supported everywhere on GitHub.

Another plugin,remark-breaks, turns soft line endings(enters) into hard breaks (<br>s).GitHub does this in a few places (comments, issues, PRs, and releases), but it’snot semantic according to HTML and not compliant to markdown.

Yet another plugin,remark-frontmatter, adds supportfor YAML frontmatter.GitHub supports frontmatter for files in Gists and repos.

Install

This package isESM only.In Node.js (version 16+), install withnpm:

npm install remark-github

In Deno withesm.sh:

importremarkGithub,{defaultBuildUrl}from'https://esm.sh/remark-github@12'

In browsers withesm.sh:

<scripttype="module">importremarkGithub,{defaultBuildUrl}from'https://esm.sh/remark-github@12?bundle'</script>

Use

Say we have the following fileexample.md:

Some references:*   Commit: f8083175fe890cbf14f41d0a06e7aa35d4989587*   Commit (fork): foo@f8083175fe890cbf14f41d0a06e7aa35d4989587*   Commit (repo): remarkjs/remark@e1aa9f6c02de18b9459b7d269712bcb50183ce89*   Issue or PR (`#`):#1*   Issue or PR (`GH-`):GH-1*   Issue or PR (fork):foo#1*   Issue or PR (project):remarkjs/remark#1*   Mention:@wooormSome links:*   Commit:<https://github.com/remarkjs/remark/commit/e1aa9f6c02de18b9459b7d269712bcb50183ce89>*   Commit comment:<https://github.com/remarkjs/remark/commit/ac63bc3abacf14cf08ca5e2d8f1f8e88a7b9015c#commitcomment-16372693>*   Issue or PR:<https://github.com/remarkjs/remark/issues/182>*   Issue or PR comment:<https://github.com/remarkjs/remark-github/issues/3#issue-151160339>*   Mention:<https://github.com/ben-eb>

…and a moduleexample.js:

import{remark}from'remark'importremarkGfmfrom'remark-gfm'importremarkGithubfrom'remark-github'import{read}from'to-vfile'constfile=awaitremark().use(remarkGfm).use(remarkGithub).process(awaitread('example.md'))console.log(String(file))

…then runningnode example.js yields:

Some references:* Commit:[`f808317`](https://github.com/remarkjs/remark-github/commit/f8083175fe890cbf14f41d0a06e7aa35d4989587)* Commit (fork):[foo@`f808317`](https://github.com/foo/remark-github/commit/f8083175fe890cbf14f41d0a06e7aa35d4989587)* Commit (repo):[remarkjs/remark@`e1aa9f6`](https://github.com/remarkjs/remark/commit/e1aa9f6c02de18b9459b7d269712bcb50183ce89)* Issue or PR (`#`):[#1](https://github.com/remarkjs/remark-github/issues/1)* Issue or PR (`GH-`):[GH-1](https://github.com/remarkjs/remark-github/issues/1)* Issue or PR (fork):[foo#1](https://github.com/foo/remark-github/issues/1)* Issue or PR (project):[remarkjs/remark#1](https://github.com/remarkjs/remark/issues/1)* Mention:[**@wooorm**](https://github.com/wooorm)Some links:* Commit:[remarkjs/remark@`e1aa9f6`](https://github.com/remarkjs/remark/commit/e1aa9f6c02de18b9459b7d269712bcb50183ce89)* Commit comment:[remarkjs/remark@`ac63bc3` (comment)](https://github.com/remarkjs/remark/commit/ac63bc3abacf14cf08ca5e2d8f1f8e88a7b9015c#commitcomment-16372693)* Issue or PR:[remarkjs/remark#182](https://github.com/remarkjs/remark/issues/182)* Issue or PR comment:[#3 (comment)](https://github.com/remarkjs/remark-github/issues/3#issue-151160339)* Mention:<https://github.com/ben-eb>

API

This package exports the identifierdefaultBuildUrl.The default export isremarkGithub.

`defaultBuildUrl(values)`

Create a URL to GH.

Parameters

values (BuildUrlValues)— info on the link to build

Returns

URL to use (string).

`unified().use(remarkGithub[, options])`

Link references to users, commits, and issues, in the same way that GitHub doesin comments, issues, PRs, and releases.

Parameters

options (Options, optional)— configuration

Returns

Transform (Transformer).

`BuildUrl`

Create a URL (TypeScript type).

Parameters

values (BuildUrlValues)— info on the link to build

Returns

URL to use orfalse to not link (string | false).

`BuildUrlCommitValues`

Info for commit hash (TypeScript type).

Fields

hash (string)— commit hash value
project (string)— project name
type ('commit')— kind
user (string)— owner of repo

`BuildUrlCompareValues`

Info for commit hash ranges (TypeScript type).

Fields

base (string)— SHA of the range start
compare (string)— SHA of the range end
project (string)— project name
type ('compare')— kind
user (string)— owner of repo

`BuildUrlIssueValues`

Info for issues (TypeScript type).

Fields

no (string)— issue number
project (string)— project name
type ('issue')— kind
user (string)— owner of repo

`BuildUrlMentionValues`

Info for mentions (TypeScript type).

Fields

type ('mention')— kind
user (string)— user name

`BuildUrlValues`

Info (TypeScript type).

Type

typeBuildUrlValues=|BuildUrlCommitValues|BuildUrlCompareValues|BuildUrlIssueValues|BuildUrlMentionValues

`Options`

Configuration (TypeScript type).

Fields

buildUrl (BuildUrl, default:defaultBuildUrl)— change how things are linked
mentionStrong (boolean, default:true)— wrap mentions instrong;this makes them render more like how GitHub styles them, but GH itselfuses CSS instead ofstrong
repository (string, default:repository frompackag.json in CWD inNode, otherwise required)— repository to link against;should point to a GitHub repository (such as'user/project')

Examples

Example:`buildUrl`

AbuildUrl can be passed to not link mentions.For example, by changingexample.js from before like so:

@@ -1,11 +1,15 @@ import {remark} from 'remark' import remarkGfm from 'remark-gfm'-import remarkGithub from 'remark-github'+import remarkGithub, {defaultBuildUrl} from 'remark-github' import {read} from 'to-vfile' const file = await remark()   .use(remarkGfm)-  .use(remarkGithub)+  .use(remarkGithub, {+    buildUrl(values) {+      return values.type === 'mention' ? false : defaultBuildUrl(values)+    }+  })   .process(await read('example.md')) console.log(String(file))

To instead point mentions to a different place, changeexample.js like so:

@@ -1,11 +1,17 @@ import {remark} from 'remark' import remarkGfm from 'remark-gfm'-import remarkGithub from 'remark-github'+import remarkGithub, {defaultBuildUrl} from 'remark-github' import {read} from 'to-vfile' const file = await remark()   .use(remarkGfm)-  .use(remarkGithub)+  .use(remarkGithub, {+    buildUrl(values) {+      return values.type === 'mention'+        ? `https://yourwebsite.com/${values.user}/`+        : defaultBuildUrl(values)+    }+  })   .process(await read('example.md')) console.log(String(file))

Syntax

The following references are supported:

Commits:1f2a4fb →1f2a4fb
Commits across forks:remarkjs@1f2a4fb →remarkjs@1f2a4fb
Commits across projects:remarkjs/remark-github@1f2a4fb →remarkjs/remark-github@1f2a4fb
Compare ranges:e2acebc...2aa9311 →e2acebc...2aa9311
Compare ranges across forks:remarkjs@e2acebc...2aa9311 →remarkjs/remark-github@e2acebc...2aa9311
Compare ranges across projects:remarkjs/remark-github@e2acebc...2aa9311 →remarkjs/remark-github@e2acebc...2aa9311
Prefix issues:GH-1 →GH-1
Hash issues:#1 →#1
Issues across forks:remarkjs#1 →remarkjs#1
Issues across projects:remarkjs/remark-github#1 →remarkjs/remark-github#1
At-mentions:@wooorm →@wooorm

Autolinks to these references are also transformed:https://github.com/wooorm ->[**@wooorm**](https://github.com/wooorm)

Types

This package is fully typed withTypeScript.It exports the additional typesBuildUrl,BuildUrlCommitValues,BuildUrlCompareValues,BuildUrlIssueValues,BuildUrlMentionValues,BuildUrlValues,DefaultBuildUrl,Options.

Compatibility

Projects maintained by the unified collective are compatible with maintainedversions of Node.js.

When we cut a new major release, we drop support for unmaintained versions ofNode.This means we try to keep the current release line,remark-github@^12,compatible with Node.js 16.

This plugin works withunified version 6+ andremark version 7+.

Security

Use ofremark-github does not involverehype (hast).It does inject links based on user content, but those links only go to GitHub.There are no openings forcross-site scripting (XSS) attacks.

remark-gfm— support GFM (autolink literals, footnotes, strikethrough, tables,tasklists)
remark-breaks— support breaks without needing spaces or escapes (enters to<br>)
remark-frontmatter— support frontmatter (YAML, TOML, and more)