Word Highlighting

1 min readStableIntermediate

Highlight every occurrence of a word or pattern using the /pattern/ syntax, useful for calling out variable names and identifiers.

Quick Start

Highlight a single literal word.

TypeScript

const secret = process.env.JWT_SECRET
const encoded = new TextEncoder().encode(secret)

Highlight a type or function name across a longer block.

TypeScript

interface DocumentPage {
  title: string
  slug: string
}
 
function renderPage(page: DocumentPage): string {
  return `# ${page.title}`
}

Combine word highlighting with line highlighting and a file title.

lib/auth.ts

TypeScript

import { SignJWT } from 'jose'
 
export async function createSession(payload) {
  return new SignJWT(payload).setProtectedHeader({ alg: 'HS256' })
}

/pattern/string

Highlights every match of the word or pattern. The match is literal, not a regular expression.

Was this page helpful?