chalvien.eu
GuidesMdx

Getting Started with MDX

This guide provides an introduction to using MDX for writing documentation and guides. It covers the basics of text formatting, lists, links, images, blockquotes, code blocks, tables, and footnotes.

Getting Started with MDX

Text Formatting

Markdown makes it easy to format text. You can write in bold, italic, or strikethrough. Combine them for bold italic text. Use inline code for technical terms.

Lists

Unordered lists use dashes, asterisks, or plus signs:

  • Import files from GitHub, Dropbox, or Google Drive
  • Export to Markdown, HTML, or PDF
  • Drag and drop files directly into the editor

Ordered lists are numbered automatically:

  1. Write your markdown
  2. Preview the rendered output
  3. Export or save to the cloud

Nested lists work too:

  • Cloud integrations
    • GitHub repositories
    • Dropbox folders
    • Google Drive files
    • OneDrive and Bitbucket
  • Local features
    • Auto-save to browser storage
    • Image paste from clipboard

Task Lists

  • Set up the editor
  • Write some markdown
  • Connect a cloud service
  • Export the finished document

Link to any page with inline links or use [reference-style links][chaalvien].

Images use a similar syntax:

Blockquotes

The art of writing is the art of discovering what you believe.

— Gustave Flaubert

Blockquotes can contain other markdown elements:

Tip: Use Cmd+Shift+Z to enter zen mode for distraction-free writing.

Code

Fenced code blocks support syntax highlighting:

function greet(name) {
  return `Hello, ${name}.`;
}

console.log(greet("world"));
def fibonacci(n):
    a, b = 0, 1
    for _ in range(n):
        a, b = b, a + b
    return a

Tables

ShortcutAction
⌘ ⇧ ZToggle zen mode
EscapeExit zen mode
?Keyboard shortcuts

Tables support alignment:

FeatureStatusNotes
Markdown editingActiveMonaco-powered
Live previewActiveScroll-synced
Cloud syncAvailable5 providers
PDF exportAvailableServer-rendered

Footnotes

Example of how to use extended markdown syntax including footnotes1 and definition lists.

Footnotes

  1. Footnotes appear at the bottom of the rendered preview

On this page