Markdown

class foxglove.layouts.MarkdownPanel

Write documentation and notes formatted using Markdown.

For more information, see the documentation.

Example

import foxglove.layouts as fl

layout = fl.Layout(
    content=fl.MarkdownPanel(
        config=fl.MarkdownConfig(
            markdown='''# My Dashboard

This is a **markdown** panel.''',
        ),
    ),
)

config: MarkdownConfig

title: str | None = None

The title of the panel.

class foxglove.layouts.MarkdownConfig

Configuration for the Markdown panel.

font_size: float | None = None

Sets the base font size for the Markdown renderer.

markdown: str | None = None

The markdown content to display.

message_path: str | None = None

Message path to a field containing Markdown text as a string.

render_mode: Literal['static', 'message'] = 'static'

Choose whether to render static markdown or message data.