Links

Markdown links use standard syntax:

[Project docs](https://example.com/docs)

Default Behavior

• Link text renders inline.
• Link color can be customized via link.linkColor.
• PDF link action is added when allowed.

Security-Aware Behavior

When security.enabled is true:

• URLs are validated by protocol and optional custom policy.
• If security.disablePdfLinks is true, link text remains but click action is removed.
• Blocked links follow violationMode:
  • skip: render as plain text
  • throw: abort render with SecurityViolationError
  • placeholder: replace with security.placeholderText

Relevant Options

Option	Effect
link.linkColor	RGB tuple for link text color
security.disablePdfLinks	Removes clickable PDF action
security.allowedLinkProtocols	Allowed protocols (for example https:)
security.validateUrl	Custom link/image URL validation hook
security.violationMode	skip / throw / placeholder
security.placeholderText	Placeholder text for blocked links

Example

security: {
  enabled: true,
  allowedLinkProtocols: ['https:', 'mailto:'],
  disablePdfLinks: false,
  violationMode: 'placeholder',
  placeholderText: '[blocked link]',
}

Try It

Interactive

Try this element in the Playground.