> For the complete documentation index, see llms.txt.
Skip to main content

Check out Port for yourself ➜ 

Markdown

Markdown inputs allow users to provide formatted Markdown content.

Common usage​

The Markdown input type can be used for:

  • Release notes.
  • Runbooks and instructions.
  • Descriptions.
  • Comments.

Definition​

{
  "releaseNotes": {
    "title": "Release Notes",
    "description": "Notes for this release",
    "type": "string",
    "format": "markdown"
  }
}

Properties​

PropertyTypeDescription
type"string"Required. Must be "string"
format"markdown"Required. Must be "markdown"
defaultstringDefault Markdown content

Example with default​

{
  "releaseNotes": {
    "title": "Release Notes",
    "description": "Notes for this release",
    "type": "string",
    "format": "markdown",
    "default": "## Changes\n\n- Added health checks.\n- Updated the deployment image."
  }
}

In the form​

In the execution form, the Markdown value appears in a text field. Click Edit to open a full-screen editor with a live preview and a toolbar. Click Save to apply the content. The submitted value is the Markdown string.

When the input is read-only, the button is Expand and the editor opens in preview mode.

Upload images​

You can add images directly to your content while editing a markdown property in Port.

Use any of the following methods to upload an image:

  • Paste from clipboard: copy an image and paste it into the editor with Cmd+V (macOS) or Ctrl+V (Windows/Linux).
  • Drag & drop: drag an image file from your computer into the editor.
  • Toolbar: click the image button in the editor toolbar to select a file to upload.

To insert an image hosted at an external URL, use Ctrl+K and provide the image URL.

Limitations:

  • Maximum file size: 10MB per image.
  • Maximum 50 uploaded images per markdown property.
  • Supported formats are PNG, JPEG, GIF, WebP, APNG, and AVIF.

Mermaid​

The preview renders Mermaid diagrams from fenced mermaid code blocks.