Class MarkdownReplacer

registerMarkdownTag

• registerMarkdownTag(tagName: `@${string}`, paramsRegExp: null | RegExp, callback: MarkdownReplacer.ReplaceCallback, options?: IRegisterOptions): void

• Register an inline tag (eg. {@tag ....}) to replace in markdown with optional params regex and execute a callback to replace it.

  Parameters

  • tagName: `@${string}`

    The name of the tag to match.

  • paramsRegExp: null | RegExp

    An optional regex to capture params.

  • callback: MarkdownReplacer.ReplaceCallback

    The callback to execute to replace the match.

  • options: IRegisterOptions = {}

    Extra options.

  Returns void