remarkjs/remark-github remarkjs/remark-github

  • Stars
    star
    163
  • Rank 222,793 (Top 5 %)
  • Language
    JavaScript
  • License
    MIT License
  • Created about 9 years ago
  • Updated 7 months ago
Twitter logo Share LinkedIn logo Share Facebook logo Share
remarkjs/remark-github
github

remarkjs

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

remark plugin to link references to commits, issues, pull-requests, and users, like on GitHub

remark-github

Build Coverage Downloads Size Sponsors Backers Chat

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).

Contents

What is this?

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

unified is a project that transforms content with abstract syntax trees (ASTs). remark adds support for markdown to unified. mdast is the markdown AST that remark uses. This is a remark plugin that transforms mdast.

When should I use this?

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.

Install

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

npm install remark-github

In Deno with esm.sh:

import remarkGithub from 'https://esm.sh/remark-github@11'

In browsers with esm.sh:

<script type="module">
  import remarkGithub from 'https://esm.sh/remark-github@11?bundle'
</script>

Use

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 our module, example.js, looks as follows:

import {read} from 'to-vfile'
import {remark} from 'remark'
import remarkGfm from 'remark-gfm'
import remarkGithub from 'remark-github'

const file = await remark()
  .use(remarkGfm)
  .use(remarkGithub)
  .process(await read('example.md'))

console.log(String(file))

Now, running node example 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 no identifiers. The default export is remarkGithub.

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

Link references to users, commits, and issues, in the same way that GitHub does in comments, issues, PRs, and releases (see Writing on GitHub).

options

Configuration (optional).

options.repository

Repository to link against (string, optional). Detected in Node.js from the repository field in package.json if not given. Should point to a GitHub repository, such as 'https://github.com/user/project.git' or 'user/project'.

options.mentionStrong

Wrap mentions in strong (boolean, default: true). This makes them render more like how GitHub styles them. But GitHub itself uses CSS instead of strong.

options.buildUrl

Change how (and whether) things are linked (Function, optional). This can be used to point links to GitHub Enterprise or other places. It’s called with the following parameters:

  • values (BuildUrlValues) β€” info on the link to build
  • defaultBuildUrl ((values: BuildUrlValues) => string) β€” function that can be called to perform normal behavior

It should return the URL to use (string) or false to not create a link.

The following schemas are passed as BuildUrlValues:

  • {type: 'commit', user, project, hash}
  • {type: 'compare', user, project, base, compare}
  • {type: 'issue', user, project, no}
  • {type: 'mention', user}

Examples

Example: buildUrl

A buildUrl can be passed to not link mentions. For example, by changing example.js from before like so:

@@ -8,7 +8,11 @@ main()
 async function main() {
   const file = await remark()
     .use(remarkGfm)
-    .use(remarkGithub)
+    .use(remarkGithub, {
+      buildUrl(values, defaultBuildUrl) {
+        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:

@@ -8,7 +8,13 @@ main()
 async function main() {
   const file = await remark()
     .use(remarkGfm)
-    .use(remarkGithub)
+    .use(remarkGithub, {
+      buildUrl(values, defaultBuildUrl) {
+        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:

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

Types

This package is fully typed with TypeScript. It exports an Options type, which specifies the interface of the accepted options. There are also BuildUrl, BuildUrlValues, BuildUrlCommitValues, BuildUrlCompareValues, BuildUrlIssueValues, BuildUrlMentionValues, and DefaultBuildUrl types exported.

Compatibility

Projects maintained by the unified collective are compatible with all maintained versions of Node.js. As of now, that is Node.js 12.20+, 14.14+, and 16.0+. Our projects sometimes work with older versions, but this is not guaranteed.

This plugin works with unified version 6+ and remark version 7+.

Security

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.

Related

  • 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)

Contribute

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.

License

MIT Β© Titus Wormer

More Repositories

1

react-markdown

Markdown component for React
JavaScript
12,040
star
2

remark

markdown processor powered by plugins part of the @unifiedjs collective
JavaScript
7,111
star
3

remark-lint

plugins to check (lint) markdown code style
JavaScript
901
star
4

remark-gfm

remark plugin to support GFM (autolink literals, footnotes, strikethrough, tables, tasklists)
JavaScript
593
star
5

remark-react

Legacy plugin to transform to React β€” please use `remark-rehype` and `rehype-react` instead
JavaScript
523
star
6

remark-toc

plugin to generate a table of contents (TOC)
JavaScript
375
star
7

awesome-remark

Curated list of awesome remark resources
347
star
8

remark-math

remark and rehype plugins to support math
JavaScript
333
star
9

remark-html

plugin to add support for serializing HTML
JavaScript
298
star
10

remark-frontmatter

remark plugin to support frontmatter (YAML, TOML, and more)
JavaScript
237
star
11

remark-rehype

plugin that turns markdown into HTML to support rehype
JavaScript
234
star
12

remark-directive

remark plugin to support directives
JavaScript
206
star
13

react-remark

React component and hook to use remark to render markdown
TypeScript
170
star
14

strip-markdown

plugin remove Markdown formatting
JavaScript
122
star
15

remark-validate-links

plugin to check that Markdown links and images reference existing files and headings
JavaScript
105
star
16

remark-breaks

plugin to add break support, without needing spaces
JavaScript
101
star
17

remark-man

plugin to compile markdown to man pages
JavaScript
94
star
18

remark-slug

Legacy plugin to add `id`s to headings β€” please use `rehype-slug`
JavaScript
91
star
19

remark-lint-no-dead-urls

Ensure that external links in your Markdown are alive
JavaScript
72
star
20

remark-unwrap-images

plugin to remove the wrapping paragraph for images
JavaScript
71
star
21

remark-highlight.js

Legacy plugin to highlight code blocks with highlight.js β€” please use `rehype-highlight` instead
JavaScript
69
star
22

remark-autolink-headings

Legacy remark plugin to automatically add links to headings β€” please use `rehype-autolink-headings` instead
JavaScript
67
star
23

remark-external-links

Legacy plugin to automatically add target and rel attributes to external links β€” please use `rehype-external-links` instead
JavaScript
55
star
24

vscode-remark

Lint and format markdown code with remark
JavaScript
51
star
25

remark-vdom

Legacy plugin to compile Markdown to Virtual DOM β€” please use `remark-rehype` and then something like `rehype-react`
JavaScript
45
star
26

remark-usage

plugin to add a usage example to your readme
JavaScript
40
star
27

remark-footnotes

Legacy plugin to add support for pandoc footnotes β€” please use `remark-gfm` instead
JavaScript
40
star
28

remark-gemoji

plugin to turn gemoji shortcodes into emoji πŸ‘
JavaScript
37
star
29

remark-textr

plugin to make your typography better with Textr
JavaScript
35
star
30

remark-images

plugin to add a simpler image syntax
JavaScript
31
star
31

remark-embed-images

plugin to embed local images as data URIs
HTML
30
star
32

remark-language-server

A language server to lint and format markdown files with remark
JavaScript
28
star
33

remark-jsx

A simple way to use React inside Markdown.
JavaScript
28
star
34

remark-reference-links

plugin to change links and images to references with separate definitions
JavaScript
25
star
35

remark-contributors

plugin to generate a list of contributors
JavaScript
22
star
36

remark-retext

plugin to transform from remark (Markdown) to retext (natural language)
JavaScript
22
star
37

remark-inline-links

plugin to change references and definitions into normal links and images
JavaScript
20
star
38

remark-license

plugin to generate a license section
JavaScript
19
star
39

remark-defsplit

plugin to change links and images to references with separate definitions
JavaScript
18
star
40

remark-bookmarks

plugin to manage links
JavaScript
15
star
41

remark-comment-config

plugin to configure remark with comments
JavaScript
13
star
42

remark-git-contributors

plugin to generate a list of Git contributors
JavaScript
12
star
43

remark-normalize-headings

plugin to make sure there is a single top level heading in a document by adjusting heading ranks accordingly
JavaScript
11
star
44

remark-squeeze-paragraphs

plugin to remove empty (or white-space only) paragraphs
JavaScript
10
star
45

gulp-remark

Legacy Gulp plugin for remark β€” please use npm scripts and the like
JavaScript
10
star
46

remark-strip-badges

plugin to strip badges (such as shields.io)
JavaScript
9
star
47

remark-message-control

plugin to enable, disable, and ignore messages
JavaScript
8
star
48

remark-yaml-config

plugin to configure remark with YAML frontmatter
JavaScript
7
star
49

.github

Community health files for remark
TypeScript
7
star
50

remark-heading-gap

plugin to adjust the gap between headings in markdown
JavaScript
5
star
51

ideas

Share ideas for new utilities and tools built with @remarkjs
5
star
52

remark-unlink

plugin to remove all links, images, references, and definitions
JavaScript
5
star
53

grunt-remark

Grunt task for remark
4
star
54

remark-word-wrap

Please use something like https://github.com/prettier/prettier instead
JavaScript
4
star
55

remark-midas

plugin to highlight CSS code blocks with midas
3
star
56

remark-comment-blocks

Use something like https://github.com/3rd-Eden/commenting instead
JavaScript
2
star
57

governance

How @remarkjs and the projects under it are governed
2
star