transform.ts#

2 documented symbols. Read the signatures first, then expand each item for parameters, return types, and examples.

2 symbols 2 functions 7 parameters 1 returns

Reference#

rehypeGitHub(repoDataMap: Map<string, GitHubRepoData | null>, sourceDataMap: Map<string, GitHubSourceData | null>, resourceDataMap: Map<string, GitHubResourceData | null>, options: Required<GitHubOptions>)

Rehype plugin to transform GitHub components.4 params

Rehype plugin to transform GitHub components.

Signature

function rehypeGitHub(repoDataMap: Map<string, GitHubRepoData | null>, sourceDataMap: Map<string, GitHubSourceData | null>, resourceDataMap: Map<string, GitHubResourceData | null>, options: Required<GitHubOptions>)

View source

Parameters

repoDataMap Map<string, GitHubRepoData | null>
sourceDataMap Map<string, GitHubSourceData | null>
resourceDataMap Map<string, GitHubResourceData | null>
options Required<GitHubOptions>

transformGitHub(html: string, repoDataMap?: Map<string, GitHubRepoData | null>, options?: GitHubOptions): Promise<string>

Transform GitHub components in HTML.3 paramsreturns Promise<string>

Transform GitHub components in HTML.

Signature

export async function transformGitHub(html: string, repoDataMap?: Map<string, GitHubRepoData | null>, options?: GitHubOptions): Promise<string>

View source

Parameters

html string
repoDataMap Map<string, GitHubRepoData | null>

optional
options GitHubOptions

optional

Returns

Promise<string>