TextDocument

A text element intended to be displayed in its own text-box.

Supports raw text and markdown.

Components

Required: Text

Optional: MediaType

Example

Markdown text document

"""Log a `TextDocument`.""" import rerun as rr rr.init("rerun_example_text_document", spawn=True) rr.log("text_document", rr.TextDocument("Hello, TextDocument!")) rr.log( "markdown", rr.TextDocument( ''' # Hello Markdown! [Click here to see the raw text](recording://markdown:Text). Basic formatting: | **Feature** | **Alternative** | | ----------------- | --------------- | | Plain | | | *italics* | _italics_ | | **bold** | __bold__ | | ~~strikethrough~~ | | | `inline code` | | ---------------------------------- ## Support - [x] [Commonmark](https://commonmark.org/help/) support - [x] GitHub-style strikethrough, tables, and checkboxes - Basic syntax highlighting for: - [x] C and C++ - [x] Python - [x] Rust - [ ] Other languages ## Links You can link to [an entity](recording://markdown), a [specific instance of an entity](recording://markdown[#0]), or a [specific component](recording://markdown:Text). Of course you can also have [normal https links](https://github.com/rerun-io/rerun), e.g. <https://rerun.io>. ## Image ![A random image](https://picsum.photos/640/480) '''.strip(), media_type=rr.MediaType.MARKDOWN, ), )