Features

Everything on these pages is written in ordinary Markdown. Each page shows the source and the rendered result side by side, so you can copy what you need.

Write

  • Formatting - Headings, emphasis, lists, links, and collapsible sections
  • Code Blocks - Syntax highlighting, titles, and copy buttons
  • Tables - Column alignment and formatting inside cells
  • Callouts - Notes, tips, and warnings with GitHub's alert syntax
  • Footnotes - Numbered notes with hover previews
  • Keyboard Keys - Shortcuts such as Cmd+S drawn as keycaps

Illustrate

  • Diagrams - Mermaid, PlantUML, and context diagrams as static SVG
  • Math - GitHub-compatible formulas as static SVG
  • Icons and Emojis - Thousands of icons, colored logos, and emoji shortcodes
  • Images - Local and remote images with a lightbox
  • Media Links - Direct MP4 playback and YouTube and Vimeo players that load only with consent
  • Hero Banner - An animated beach scene for landing pages

Organize

  • Navigation - Sidebar, top tabs, breadcrumbs, ordering, and the page footer

Compose

Document APIs

  • OpenAPI Spec - Add a static API reference from a local OpenAPI specification

Publish

  • PDF Link - Place a link to the generated PDF anywhere in your pages

Search documentation

Press Esc to close

Start typing to search the documentation.

Media settings

Choose which providers may load videos automatically across this site. Your choices are stored in this browser.