Skip to main content

Module markdown

Module markdown 

Source
Expand description

Read-only whole-document and append-stream Markdown rendering.

Structs§

Fingerprint
MarkdownBlock
A commentable or structurally significant Markdown block.
MarkdownBlockAnchor
Durable identity and context for a non-code-line Markdown target.
MarkdownCodeBlock
A fenced or indented code block.
MarkdownCodeLine
One content line inside a code block.
MarkdownCodeLineAnchor
Durable identity for a code line, including the identity of its parent block.
MarkdownCommentContext
Context retained with a Markdown comment so it remains useful when outdated.
MarkdownCommentDraft
An editable UTF-8-safe Markdown comment draft.
MarkdownDocument
A parsed Markdown document.
MarkdownHeading
A heading in document outline order.
MarkdownLineRange
A one-based, inclusive range of lines in the original Markdown source.
MarkdownListItem
One list item. The list container itself is not a review target.
MarkdownParseStats
MarkdownRenderStats
Deterministic work counters for incremental Markdown rendering.
MarkdownRenderer
Stateless whole-document renderer plus streaming cache services.
MarkdownReview
Mutable collection of Markdown review comments.
MarkdownReviewComment
A review comment retained even when its Markdown target disappears.
MarkdownReviewSession
State for reviewing one parsed Markdown document.
MarkdownReviewSubmission
The durable result emitted by a Markdown review session.
MarkdownSourceStyle
MarkdownStream
MarkdownStreamChanges
MarkdownStreamIdentity
MarkdownStreamUpdate
MarkdownTable
A table and its rows. Cells are structural and are not independent targets.
MarkdownTableCell
One structural table cell.
MarkdownTableRow
One table row, including the header row when one exists.
MarkdownTarget
A selectable target in document order.
MarkdownTargetId
An opaque identifier valid only for the lifetime of one parsed document.
SourceRange
A byte and line range into the original, unmodified source.
StreamingMarkdownState
Renderer-owned cache for one logical streaming Markdown item.

Enums§

FingerprintError
Errors produced while decoding a hexadecimal fingerprint.
MarkdownAnchor
An identity for either a semantic Markdown block or one code line.
MarkdownBlockKind
The semantic kinds of blocks exposed to renderers.
MarkdownCommitError
MarkdownFocusPane
MarkdownInline
A formatted inline Markdown node.
MarkdownReviewCommand
MarkdownReviewDecision
The explicit decision made at the end of a Markdown review.
MarkdownReviewError
Errors raised while producing a submission.
MarkdownReviewEvent
Events emitted by a Markdown review frontend.
MarkdownSourceRole
MarkdownStreamError
MarkdownTableAlignment
Alignment requested by a Markdown table delimiter.
MarkdownTargetKind
The semantic kinds that can be selected and commented on.
StreamingMarkdownPolicy

Constants§

SNAPSHOT_CHAR_LIMIT
Maximum number of Unicode scalar values retained in an anchor snapshot.

Functions§

anchor_for_target
Creates an anchor for id, retaining a bounded source snapshot.
format_markdown_review
Formats a Markdown review for an agent or a human copying feedback.
parse_markdown
Parses Markdown into a renderer-neutral semantic document.
rendered_text
Returns the rendered, style-free text represented by inline nodes.
resolve_anchor
Resolves an anchor using context, heading path, content, and source proximity.