rehype-github-notranslate

rehype plugin to enhance raw text with notranslate.

Contents

• What is this?
• When should I use this?
• Install
• Use
• API
  • defaultInclude
  • rehypeGithubNoTranslate(options?)
  • Options
• Bugs
• Authoring
• HTML
• CSS
• Syntax
• Types
• Compatibility
• Security
• Related
• Contribute
• Notice
• License

What is this?

This plugin enhances raw text by adding a mark to them that tells tools like Google Translate to not translate them. By default it adds class="notranslate" to pre and code.

This behavior is specific to github.com that only work in comments, not in files.

This plugin is part of a monorepo rehype-github. See its readme for more info.

When should I use this?

You can use this plugin when you want to match how github.com works or when you want to build similar pipelines that have user content.

Install

This package is ESM only. In Node.js (version 16+), install with npm:

1npm install rehype-github-notranslate

In Deno with esm.sh:

1import rehypeGithubNoTranslate from 'https://esm.sh/rehype-github-notranslate@1'

In browsers with esm.sh:

1<script type="module">
2  import rehypeGithubNoTranslate from 'https://esm.sh/rehype-github-notranslate@1?bundle'
3</script>

Use

Say our module example.js looks as follows:

1import rehypeGithubNoTranslate from 'rehype-github-notranslate'
2import rehypeParse from 'rehype-parse'
3import rehypeStringify from 'rehype-stringify'
4import {unified} from 'unified'
5
6const file = await unified()
7  .use(rehypeParse, {fragment: true})
8  .use(rehypeGithubNoTranslate)
9  .use(rehypeStringify)
10  .process('<code>xxx</code>')
11
12console.log(String(file))

…now running node example.js yields:

1<code class="notranslate">xxx</code>

API

This package exports the identifier defaultInclude. The default export is rehypeGithubNoTranslate.

defaultInclude

List of tag names that github.com enhances (Array<string>).

rehypeGithubNoTranslate(options?)

Plugin to enhance raw text with notranslate.

Parameters

• options (Options, optional) — configuration

Options

Configuration (TypeScript type).

Fields

• include (Array<string>, default: defaultInclude) — elements to enhance; the default behavior is to add notranslate to code and pre

Bugs

There are no particular bugs with how this work, other than that they could do this on files too, and that they should perhaps use ['code', 'kbd', 'pre', 'tt'] instead. Furthermore, there are cases where you would want code to be translated, that automation can’t solve.

Authoring

There are no additional recommendations on how to author links in markdown.

HTML

The markup for that github.com adds is:

1class="notranslate"

CSS

No CSS is needed.

Syntax

No syntax is applicable.

Types

This package is fully typed with TypeScript. It exports the additional type Options.

Compatibility

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

This plugin works with rehype-parse version 3+, rehype-stringify version 3+, rehype version 5+, and unified version 6+.

Security

This package is safe.

Related

• remark-gfm — support GFM in remark

Contribute

See contributing.md in rehypejs/.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.

Notice

This project is not affiliated with GitHub.

License

MIT © Titus Wormer