![Introducing Enhanced Alert Actions and Triage Functionality](https://cdn.sanity.io/images/cgdhsj6q/production/fe71306d515f85de6139b46745ea7180362324f0-2530x946.png?w=800&fit=max&auto=format)
Product
Introducing Enhanced Alert Actions and Triage Functionality
Socket now supports four distinct alert actions instead of the previous two, and alert triaging allows users to override the actions taken for all individual alerts.
remark-github
Advanced tools
Readme
remark plugin to link references to commits, issues, and users, in the same way that GitHub does in comments, issues, PRs, and releases (see Writing on GitHub).
This package is a unified (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 GitHub comments, 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 as markdown in a repo or Gist). This plugin does not support other platforms such as GitLab or Bitbucket and their custom features.
A different plugin, remark-gfm
, adds support for GFM (GitHub
Flavored 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’s
not semantic according to HTML and not compliant to markdown.
Yet another plugin, remark-frontmatter
, adds support
for YAML frontmatter.
GitHub supports frontmatter for files in Gists and repos.
This package is ESM only. In Node.js (version 16+), install with npm:
npm install remark-github
In Deno with esm.sh
:
import remarkGithub, {defaultBuildUrl} from 'https://esm.sh/remark-github@12'
In browsers with esm.sh
:
<script type="module">
import remarkGithub, {defaultBuildUrl} from 'https://esm.sh/remark-github@12?bundle'
</script>
Say we have the following file example.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: @wooorm
Some 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 module example.js
:
import {remark} from 'remark'
import remarkGfm from 'remark-gfm'
import remarkGithub from 'remark-github'
import {read} from 'to-vfile'
const file = await remark()
.use(remarkGfm)
.use(remarkGithub)
.process(await read('example.md'))
console.log(String(file))
…then running node 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>
This package exports the identifier defaultBuildUrl
.
The default export is remarkGithub
.
defaultBuildUrl(values)
Create a URL to GH.
values
(BuildUrlValues
)
— info on the link to buildURL to use (string
).
unified().use(remarkGithub[, options])
Link references to users, commits, and issues, in the same way that GitHub does in comments, issues, PRs, and releases.
options
(Options
, optional)
— configurationTransform (Transformer
).
BuildUrl
Create a URL (TypeScript type).
values
(BuildUrlValues
)
— info on the link to buildURL to use or false
to not link (string | false
).
BuildUrlCommitValues
Info for commit hash (TypeScript type).
hash
(string
)
— commit hash valueproject
(string
)
— project nametype
('commit'
)
— kinduser
(string
)
— owner of repoBuildUrlCompareValues
Info for commit hash ranges (TypeScript type).
base
(string
)
— SHA of the range startcompare
(string
)
— SHA of the range endproject
(string
)
— project nametype
('compare'
)
— kinduser
(string
)
— owner of repoBuildUrlIssueValues
Info for issues (TypeScript type).
no
(string
)
— issue numberproject
(string
)
— project nametype
('issue'
)
— kinduser
(string
)
— owner of repoBuildUrlMentionValues
Info for mentions (TypeScript type).
type
('mention'
)
— kinduser
(string
)
— user nameBuildUrlValues
Info (TypeScript type).
type BuildUrlValues =
| BuildUrlCommitValues
| BuildUrlCompareValues
| BuildUrlIssueValues
| BuildUrlMentionValues
Options
Configuration (TypeScript type).
buildUrl
(BuildUrl
, default:
defaultBuildUrl
)
— change how things are linkedmentionStrong
(boolean
, default: true
)
— wrap mentions in strong
;
this makes them render more like how GitHub styles them, but GH itself
uses CSS instead of strong
repository
(string
, default: repository
from packag.json
in CWD in
Node, otherwise required)
— repository to link against;
should point to a GitHub repository (such as 'user/project'
)buildUrl
A buildUrl
can be passed to not link mentions.
For example, by changing example.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, change example.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))
The following references are supported:
1f2a4fb
→
1f2a4fb
remarkjs@1f2a4fb
→
remarkjs@1f2a4fb
remarkjs/remark-github@1f2a4fb
→
remarkjs/remark-github@1f2a4fb
e2acebc...2aa9311
→
e2acebc...2aa9311
remarkjs@e2acebc...2aa9311
→
remarkjs/remark-github@e2acebc...2aa9311
remarkjs/remark-github@e2acebc...2aa9311
→
remarkjs/remark-github@e2acebc...2aa9311
GH-1
→
GH-1#1
→
#1remarkjs#1
→
remarkjs#1remarkjs/remark-github#1
→
remarkjs/remark-github#1@wooorm
→
@wooormAutolinks to these references are also transformed:
https://github.com/wooorm
-> [**@wooorm**](https://github.com/wooorm)
This package is fully typed with TypeScript.
It exports the additional types
BuildUrl
,
BuildUrlCommitValues
,
BuildUrlCompareValues
,
BuildUrlIssueValues
,
BuildUrlMentionValues
,
BuildUrlValues
,
DefaultBuildUrl
,
Options
.
Projects maintained by the unified collective are compatible with maintained versions of Node.js.
When we cut a new major release, we drop support for unmaintained versions of
Node.
This means we try to keep the current release line, remark-github@^12
,
compatible with Node.js 16.
This plugin works with unified
version 6+ and remark
version 7+.
Use of remark-github
does not involve rehype (hast).
It does inject links based on user content, but those links only go to GitHub.
There are no openings for cross-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)See contributing.md
in remarkjs/.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
remark plugin to autolink references like in GitHub issues, PRs, and comments
The npm package remark-github receives a total of 134,376 weekly downloads. As such, remark-github popularity was classified as popular.
We found that remark-github demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 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.
Product
Socket now supports four distinct alert actions instead of the previous two, and alert triaging allows users to override the actions taken for all individual alerts.
Security News
Polyfill.io has been serving malware for months via its CDN, after the project's open source maintainer sold the service to a company based in China.
Security News
OpenSSF is warning open source maintainers to stay vigilant against reputation farming on GitHub, where users artificially inflate their status by manipulating interactions on closed issues and PRs.