Class MarkdownService

Index

Constructors

Methods

addCodeCopyButtons configureMarked getConfig getHeadingList getSupportedLanguages highlightCode initializeCollapsibleHeadings isLanguageSupported parse parseAsync renderMermaid resetConfig sanitizeHtml

Constructors

constructor

new MarkdownService(): MarkdownService
Returns MarkdownService
- Defined in services/markdown.service.ts:132

Methods

addCodeCopyButtons

addCodeCopyButtons(container: HTMLElement): void
Add copy buttons to code blocks
Parameters
- container: HTMLElement
  The DOM element containing code blocks
Returns void
- Defined in services/markdown.service.ts:361

configureMarked

configureMarked(config: MarkdownConfig): void
Configure the underlying engine with the provided options.
Parameters
- config: MarkdownConfig
Returns void
- Defined in services/markdown.service.ts:139

getConfig

getConfig(): ResolvedMarkdownConfig
Get the current configuration

Returns ResolvedMarkdownConfig
- Defined in services/markdown.service.ts:431

getHeadingList

getHeadingList(): HeadingInfo[]
Get the list of headings from the last parsed document Useful for building table of contents

Returns HeadingInfo[]
- Defined in services/markdown.service.ts:424

getSupportedLanguages

getSupportedLanguages(): string[]
Get list of supported Prism languages

Returns string[]
- Defined in services/markdown.service.ts:452

highlightCode

highlightCode(container: HTMLElement): void
Highlight code blocks with Prism Call this after the HTML has been inserted into the DOM
Parameters
- container: HTMLElement
  The DOM element containing code blocks
Returns void
- Defined in services/markdown.service.ts:350

initializeCollapsibleHeadings

initializeCollapsibleHeadings(_container: HTMLElement): void
Initialize collapsible heading functionality This method is a no-op - the component handles event binding
Parameters
- _container: HTMLElement
Returns void
- Defined in services/markdown.service.ts:415

isLanguageSupported

isLanguageSupported(lang: string): boolean
Check if a language is supported by Prism
Parameters
- lang: string
Returns boolean
- Defined in services/markdown.service.ts:445

parse

parse(markdown: string, config?: Partial<MarkdownConfig>): string
Parse markdown to HTML.
Parameters
- markdown: string
  The markdown string to parse
- Optionalconfig: Partial<MarkdownConfig>
  Optional config overrides for this parse operation
Returns string
The rendered HTML string
- Defined in services/markdown.service.ts:150

parseAsync

parseAsync(markdown: string, config?: Partial<MarkdownConfig>): Promise<string>
Parse markdown asynchronously (useful for large documents)
Parameters
- markdown: string
- Optionalconfig: Partial<MarkdownConfig>
Returns Promise<string>
- Defined in services/markdown.service.ts:194

renderMermaid

renderMermaid(container: HTMLElement): Promise<boolean>
Render Mermaid diagrams in a container element Call this after the HTML has been inserted into the DOM
Parameters
- container: HTMLElement
  The DOM element containing mermaid code blocks
Returns Promise<boolean>
- Defined in services/markdown.service.ts:272

resetConfig

resetConfig(): void
Reset configuration to defaults

Returns void
- Defined in services/markdown.service.ts:438

sanitizeHtml

sanitizeHtml(html: string): string
Sanitize rendered HTML for binding to innerHTML while preserving layout HTML, inline styles and inline SVG. See the DOMPurify configuration at the top of this file for what is kept and removed. Where no DOM is available to sanitize with, the markup is escaped and rendered as text rather than trusted.
Parameters
- html: string
Returns string
- Defined in services/markdown.service.ts:183