Class MarkedPluginInternal

constructor

• new MarkedPlugin(owner: Renderer): MarkedPlugin

  Parameters

  • owner: Renderer

  Returns MarkedPlugin

componentName

application

• get application(): Application

  Return the application / root component instance.

  Returns Application

darkTheme

lightTheme

markdownItOptions

markdownLinkExternal

owner

• get owner(): O

  Return the owner of this component.

  Returns O

validation

getHighlighted

• getHighlighted(text: string, lang?: string): string

  Highlight the syntax of the given text using Shiki.

  Parameters

  • text: string

    The text that should be highlighted.

  • Optionallang: string

    The language that should be used to highlight the string.

  Returns string

  A html string with syntax highlighting.

getRelativeUrl

• getRelativeUrl(absolute: string): string

  Transform the given absolute path into a relative path.

  Parameters

  • absolute: string

    The absolute path to transform.

  Returns string

  A path relative to the document currently processed.

off

• off<K extends never>(
      event: K,
      listener: (this: undefined, ...args: {}[K]) => void,
  ): void

  Stops listening to an event.

  Type Parameters

  • K extends never

  Parameters

  • event: K

    the event to stop listening to.

  • listener: (this: undefined, ...args: {}[K]) => void

    the function to remove from the listener array.

  Returns void

on

• on<K extends never>(
      event: K,
      listener: (this: undefined, ...args: {}[K]) => void,
      priority?: number,
  ): void

  Starts listening to an event.

  Type Parameters

  • K extends never

  Parameters

  • event: K

    the event to listen to.

  • listener: (this: undefined, ...args: {}[K]) => void

    function to be called when an this event is emitted.

  • Optionalpriority: number

    optional priority to insert this hook with. Higher priority is placed earlier in the listener array.

  Returns void

onParseMarkdown

• onParseMarkdown(event: MarkdownEvent): void

  Triggered when MarkedPlugin parses a markdown string.

  Parameters

  • event: MarkdownEvent

  Returns void

parseMarkdown

• parseMarkdown(
      input: string | readonly CommentDisplayPart[],
      page: PageEvent<any>,
      context: DefaultThemeRenderContext,
  ): string

  Parse the given markdown string and return the resulting html.

  Parameters

  • input: string | readonly CommentDisplayPart[]

    The markdown string that should be parsed.

  • page: PageEvent<any>
  • context: DefaultThemeRenderContext

  Returns string

  The resulting html string.

trigger

• trigger<K extends never>(event: K, ...args: {}[K]): void

  Emits an event to all currently subscribed listeners.

  Type Parameters

  • K extends never

  Parameters

  • event: K

    the event to emit.

  • ...args: {}[K]

    any arguments required for the event.

  Returns void