Skip to main content
Module

x/gfm/mod.ts>Marked.MarkedOptions

Server-side GitHub Flavored Markdown rendering for Deno
Latest
interface Marked.MarkedOptions
implements Omit<MarkedExtension,
| "hooks"
| "renderer"
| "tokenizer"
| "extensions"
| "walkTokens"
>
import { type Marked } from "https://deno.land/x/gfm@0.6.0/mod.ts";
const { MarkedOptions } = Marked;

Properties

optional
hooks: _Hooks | undefined | null

Hooks are methods that hook into some part of marked.

optional
renderer: _Renderer | undefined | null

Type: object Default: new Renderer()

An object containing functions to render tokens to HTML.

optional
tokenizer: _Tokenizer | undefined | null

The tokenizer defines how to turn markdown text into tokens.

optional
extensions: null | { renderers: { [name: string]: RendererExtensionFunction; }; childTokens: { [name: string]: string[]; }; inline?: TokenizerExtensionFunction[]; block?: TokenizerExtensionFunction[]; startInline?: TokenizerStartFunction[]; startBlock?: TokenizerStartFunction[]; }

Custom extensions

optional
walkTokens: null | ((token: Token) => void | Promise<void> | (void | Promise<void>)[])

walkTokens function returns array of values for Promise.all