Markdown extensions

Examples of math, Mermaid diagrams, and Twoslash code snippets

Math

Inline math uses familiar TeX syntax: $E = mc^2$ .

\sum_{i=1}^{n} i = \frac{n(n + 1)}{2}

Mermaid diagrams

Twoslash code snippets

type  = {
  : string;
  : boolean;
};

const  = {
  : "Software Factory",
  : true,
} satisfies ;

// Hover project to see its inferred type.
project; 
const project: {
    name: string;
    ready: true;
}

On this page

Math Mermaid diagrams Twoslash code snippets