Alex Edwards

MDX Glossary

Headings

Heading 4

Heading 5
Heading 6

Content Elements

Paragraph

Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Curabitur gravida arcu ac tortor dignissim convallis aenean et. Scelerisque eleifend donec pretium vulputate sapien nec sagittis aliquam.

Curabitur gravida arcu ac tortor dignissim convallis aenean et.

Blockquotes

Some one famous once said something

Inline Code

The property TestVariable equals to true

Code Blocks

import { readFile } from "node:fs/promises";

// return the file as a string
export async function getMarkdownGlossary() {
  return readFile("some/path.mdx", { encoding: "utf8" });
}
Line Highlighting
import { readFile } from "node:fs/promises";

// return the file as a string
export async function getMarkdownGlossary() {
  return readFile("some/path.mdx", { encoding: "utf8" });
}
Git Diff
import { readFile } from "node:fs/promises";

// return the file as a string
export async function getMarkdownGlossary() {
  return readFile("some/path1.mdx", { encoding: "utf8" });
  return readFile("some/path2.mdx", { encoding: "utf8" });
}
Mermaid Diagrams

Loading graph... Javascript is needed for the graph to render

Tables (Github Flavoured Markdown)

SyntaxDescription
HeaderTitle
ParagraphText

Check Lists (Github Flavoured Markdown)

  • Something to be done
  • Something done

Custom Elements

Image

Notice

CheckList + CheckListItem

  • This has been done
  • This has to be done
  • This has failed