Comark Documentation

MD Prompts provides the following capabilities for CLI development:

• Markdown Content: Write all prompt content using standard Markdown syntax.
• Interactive Components: Use specialized components to create interactive user prompts (e.g., key presses or input triggers) within the CLI.

Comark supports standard Markdown features alongside its extended component syntax:

• Inline formatting: **bold**, *italic*, `code`, and [links](url).
• Lists: Unordered (-) and ordered (1.) lists with full Markdown support inside items.
• Code blocks: Standard fenced code blocks with out-of-the-box syntax highlighting (e.g., ```js).
• Block quotes: Standard > quote syntax.
• Components: The ::name{attr="val"} syntax for embedding interactive or styled elements.

Comark is a high-performance Markdown engine designed for modern web applications with the following capabilities:

• One Parser, Every Renderer: The same source renders to Vue, React, Svelte, Angular, Nuxt, HTML, and ANSI.
• Real-time Streaming: Built-in support for parsing content as it arrives (e.g., for AI chat interfaces) with Auto-close functionality that renders incomplete syntax correctly at every frame.
• Component Syntax: Natively handles components and attributes within Markdown.
• Extensible Plugin Ecosystem: Supports Comark-specific plugins and is compatible with markdown-it plugins.
• Serializable Document Model: Parses to a MarkdownDocument that is easy to traverse, cache, serialize, and send over the wire.

The JSON Render plugin provides several capabilities for composing UI via Markdown:

• Full Spec Format: Define a complete tree of named elements starting from a root entry point.
• Single Element Shorthand: Use a simplified format when defining single elements.
• Nested Layout: Compose deep component trees by referencing children by their keys.
• YAML Support: Allows writing specifications in YAML for improved readability.
• Styling: When used in the provided example, it is styled with Nuxt UI, supporting dark mode.

Comark provides two primary utility APIs for handling markdown content:

1. parseMarkdown(): Used for parsing markdown strings into a structured format.
2. autoCloseMarkdown(): Used to handle incomplete or unclosed syntax, which is particularly useful for streaming content integration.

When a code block is provided without a language identifier (e.g., ```), Comark processes it as a plain text code block. This results in a standard pre > code structure in the HTML output without any syntax highlighting applied.

Plain text code block No language specified

When parsing nested unordered lists, Comark generates an Abstract Syntax Tree (AST) where nested lists are represented as child nodes within a list item (li) node. A list item containing a nested list will typically contain a paragraph (p) node for its text content followed by the nested ul node.

{
  "frontmatter": {},
  "meta": {},
  "nodes": [
    [
      "ul",
      {},
      [
        "li",
        {},
        "First item"
      ],
      [
        "li",
        {},
        [
          "p",
          {},
          "Third item"
        ],
        [
          "ul",
          {},
          [
            "li",
            {},
            "Indented item"
          ]
        ]
      ]
    ]
  ]
}