Skip to main content

Markdown module

📖 Description​

A helper for parsing markdown text.

💎 Classes​

⛓ī¸ Interfaces​

🔗 IMarkdownOptions​

Describes the interface for the markdown options.

Type declaration​
interface IMarkdownOptions {
  features?: MarkdownFeatures;Optional
}
🖱ī¸ Hover with the mouse over a property name for a tooltip with the description of that property. Click it for more information.

🏷ī¸ features​

Specifies the parser features.

Type​

MarkdownFeatures

📇 Enums​

📇 MarkdownFeatures​

Describes the possible markdown features.

Type declaration​
enum MarkdownFeatures {
  /* Disable all features. */
  None = 0,

  /* Allow basic formatting like bold, italic, underline and strikethrough. */
  Formatting = 1,

  /* Allow the use of paragraphs (necessary for the `Headings`, `Quotes` or `Code` features). */
  Paragraphs = 2,

  /* Allow inline breaks. */
  Breaks = 4,

  /* Allow hyperlinks. */
  Hyperlinks = 8,

  /* Allow headings. */
  Headings = 16,

  /* Allow block quotes. */
  Blockquotes = 32,

  /* Allow code blocks. */
  Code = 64,

  /* Allows inline code. */
  InlineCode = 128,

  /* Allow embedding of images. */
  Images = 256,

  /* All features. */
  All = 511
}