Documents
A .md artifact is a Markdown document the reader opens beside the conversation. It is the default choice when the answer is prose, figures and tables: a report, a summary, a checklist, an incident review.
What the assistant writes
Ordinary Markdown: a # title, headings, tables, lists, quotes and code blocks. The first # heading becomes the artifact's title in the chat and in the Artifacts space, so a document without one is listed by its file name.
cat > /artifacts/incident-review.md <<'EOF'
# Incident review: certificate expiry
On 14 July the API gateway served an expired certificate for 22 minutes.
| Time | Event |
|-------|-------------------------------|
| 09:02 | First failed health check |
| 09:24 | New certificate deployed |
EOF
publish incident-review.md
What the reader sees
The pane renders the document the way a chat reply renders, with the same sanitization. Two fenced blocks are drawn instead of shown as text:
| Fence | Drawn as |
|---|---|
```mermaid |
A diagram, drawn by Pele. |
```flint |
A chart, drawn by Flint from a chart specification. |
A picture in the sandbox goes in by its path, for example . publish reads each picture it can find and embeds the bytes in the published document, and it names the ones it embedded. A path it cannot read stays as written and is named in the output of publish.
Downloads
| Button | File |
|---|---|
| Download | The published .md file. |
| Download as PDF | A paged PDF. The workspace renders the Markdown to a Word document and converts that to PDF when the reader clicks, not when the artifact is published. |
The PDF draws Mermaid diagrams as pictures but keeps a chart's specification as text, so a document meant for print carries its numbers in a table as well. If the conversion fails, the download fails; the workspace does not hand over the intermediate Word document in place of the PDF.
DisableArtifactDownloads removes both buttons. See Settings that affect artifacts.
Check the pages
render incident-review.md draws the document the way its PDF download is drawn, so a table that runs off the page or a heading left alone at the bottom shows up before the reader sees it. The pictures come back as attachments to the call result.
Older PDF artifacts
Before Markdown artifacts existed, a .md artifact was stored as a PDF artifact. Those still open as the PDF they rendered to. Writing the source again turns them into Markdown artifacts.
Related
- Pages, decks and Word documents for a designed layout or a file in a house style.
- Data files when the reader will take the rows somewhere else.
- Make artifacts available.