lugen4ro/figma-widget-markdown-renderer

Figma Widghet for Editing and rendering Markdown directly on your FigJam board.

★ 0Forks 0TypeScriptGitHub ↗Compare

README

Markdown Widget for FigJam

A FigJam widget that renders Markdown directly on the canvas, including GFM tables.

Getting started

npm run dev
  1. Log in to your account and open the Figma desktop app
  2. Open any FigJam document (or create a new one)
  3. Go to Menu > Widgets > Development > "Import widget from manifest..."
  4. Select the manifest.json in this folder

Commands

  • npm run dev — start full dev environment (tsc watch + esbuild watch + vite dev server)
  • npm run build — production build with minification
  • npm run test — type-check both contexts then build
  • npm run format — prettier

Markdown Feature Support

Supported

  • Headings (h1–h6), with distinct h1–h3 hierarchy
  • Paragraphs
  • Bold / Italic / Strikethrough
  • Bold+italic combined (***text***)
  • Inline code
  • Fenced code blocks (dark theme)
  • Unordered lists (with nesting)
  • Ordered lists (with nesting)
  • Interactive task lists (clickable checkboxes update the Markdown source)
  • Blockquotes (with nested blockquotes)
  • Inline formatting inside blockquotes
  • Horizontal rules
  • GFM Tables (with column alignment)
  • Inline formatting inside table cells
  • Images (from URL, with alt text caption)
  • Links (colored, clickable)
  • Configurable widget width (property menu)
  • Configurable text size with proportional scaling (property menu)
  • iFrame editor with toggleable HTML preview

Not yet supported

  • Syntax highlighting in code blocks
  • Light/dark theme toggle
  • Mermaid rendering

Other To Dos

  • Confirm on close with non-saved changes
  • Editor improvements
    • tab does not jump to preview, but indents
    • simple shortcuts (like cmd+b for making selection bold)
  • Syntax highlighting for code blocks
  • Widget shows text, so you can select & copy (Move trigger for editor elsewhere)

Architecture

See docs/architecture.md for the dual-context model.

Contributors

lugen4ro

Issues