sync_markdown

TL;DR

What it does

Workflow. Turns the diagram fences of a Markdown document into pictures, as data. Send the whole document and its path. Returns the rewritten document (each fence folded into a "Diagram source" section with the picture and a text description, the rest byte for byte unchanged), the light and dark SVG files to write (paths from the repository root), and a report per fence with errors at lines of your document. convertMermaid true first turns each convertible mermaid fence into a diagram fence; one that cannot convert or has errors is left as it was and reported. Then write markdown to documentPath and each file to its path, and review the diff. mode "check" only reports. The SVGs can be large: files "none" returns each file's path, bytes, sha256, and viewUrl instead, and page with pageSize returns the files a page at a time. Writes no file itself. Limits: 10000000 characters, 30 diagrams, 2000000 bytes of output; caps says when one stopped work. Replaces the convert, validate, render and sync steps for every fence in a document.

Steps

One call performs at most 31 operations.

Example call

The arguments of the call, as JSON:

1{2  "markdown": "# Login\n\n```diagram\nflow \"Login\"\nnode user person \"User\"\nnode api service \"Auth API\"\nuser -> api : \"POST /login\"\n```\n",3  "documentPath": "docs/login.md",4  "convertMermaid": true5}

The markdown argument, written out one line at a time:

1# Login2
3```diagram4flow "Login"5node user person "User"6node api service "Auth API"7user -> api : "POST /login"8```

Prompts that lead to it

• Replace the Mermaid diagrams in README.md with Plotwork diagrams.
• Render the diagram fences in docs/login.md and give me the files to write.

Arguments

Result

Behavior hints

Bounds

A bound that is reached is reported in the result; nothing is cut silently.

See also