Marked.MarkedOptions.MarkedOptions | /mod.ts | gfm@0.4.0

interface Marked.MarkedOptions.MarkedOptions

| "renderer"

| "tokenizer"

| "extensions"

| "walkTokens"

import { type Marked } from "https://deno.land/x/gfm@0.4.0/mod.ts";
const { MarkedOptions } = Marked.MarkedOptions;

Properties

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

Properties

name: string

level: "block" | "inline"

optional

start: TokenizerStartFunction | undefined

tokenizer: TokenizerExtensionFunction

optional

childTokens: string[] | undefined

Properties

name: string

renderer: RendererExtensionFunction

Properties

optional

async: boolean

True will tell marked to await any walkTokens functions before parsing the tokens and returning an HTML string.

optional

breaks: boolean | undefined

Enable GFM line breaks. This option requires the gfm option to be true.

optional

extensions: TokenizerAndRendererExtension[] | undefined | null

Add tokenizers and renderers to marked

optional

gfm: boolean | undefined

Enable GitHub flavored markdown.

optional

hooks: { preprocess: (markdown: string) => string | Promise<string>; postprocess: (html: string) => string | Promise<string>; options?: MarkedOptions; } | null

Hooks are methods that hook into some part of marked. preprocess is called to process markdown before sending it to marked. postprocess is called to process html after marked has finished parsing.

optional

pedantic: boolean | undefined

Conform to obscure parts of markdown.pl as much as possible. Don't fix any of the original markdown bugs or poor behavior.

optional

renderer: RendererObject | undefined | null

Type: object Default: new Renderer()

An object containing functions to render tokens to HTML.

optional

silent: boolean | undefined

Shows an HTML error message when rendering fails.

optional

tokenizer: TokenizerObject | undefined | null

The tokenizer defines how to turn markdown text into tokens.

optional

walkTokens: ((token: Token) => void | Promise<void>) | undefined | null

The walkTokens function gets called with every token. Child tokens are called before moving on to sibling tokens. Each token is passed by reference so updates are persisted when passed to the parser. The return value of the function is ignored.

Properties

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

Custom extensions

optional

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

walkTokens function returns array of values for Promise.all

type alias Marked.MarkedOptions.MarkedOptions

import { type Marked } from "https://deno.land/x/gfm@0.4.0/mod.ts";
const { MarkedOptions } = Marked.MarkedOptions;

definition: (

this: TokenizerThis,

src: string,

tokens: Token[] | TokensList,

) => Tokens.Generic | undefined

definition: (this: TokenizerThis, src: string) => number | void

definition: (this: RendererThis, token: Tokens.Generic) => string | false | undefined

definition: TokenizerExtension | RendererExtension | (TokenizerExtension & RendererExtension)