Skip to main content

Module document

Module document 

Source
Expand description

JFM document format: YAML frontmatter + markdown body.

Parses and renders documents in the format:

---
type: jira
key: PROJ-123
summary: Issue title
---

Markdown body content here.

Structs§

ConfluenceFrontmatter
Confluence-specific frontmatter fields.
JfmDocument
A JFM document consisting of YAML frontmatter and a markdown body.
JiraFrontmatter
JIRA-specific frontmatter fields.

Enums§

JfmFrontmatter
YAML frontmatter for a JFM document.

Functions§

content_item_to_document
Converts a ContentItem into a JfmDocument with YAML frontmatter.
issue_to_jfm_document
Converts a JiraIssue into a JfmDocument with YAML frontmatter.
validate_issue_key
Validates that a string looks like a JIRA issue key (e.g., “PROJ-123”).