Markdown Features

SuperDocs supports standard GitHub Flavored Markdown (GFM) and MDX.

Standard Syntax

You can use all standard markdown features:

  • Bold: **text** -> text
  • Italic: *text* -> text
  • Links
  • Lists (ordered and unordered)
  • Blockquotes

Code Blocks

We use Shiki for syntax highlighting.

console.log('Hello World');

Callouts / Admonitions

We support GitHub style alerts:

MDX Components

You can import and use components directly in your markdown. By default, SuperDocs exports several built-in components globally (no import needed).

Cards

star

Example Card

This is a card component.

Tabs

Terminal window
npm install superdocs
Terminal window
yarn add superdocs