Keep Markdown in your workflow.
Continue generating and editing the source as a normal .mdfile. Viewable handles the human-facing reading surface when it is time to share the result.
Share a Markdown file
Share Markdown as a private, readable page.
Agent-written plans, research notes, QA reports, and technical briefs often finish as local Markdown. Viewable renders that file as a clean browser document so the recipient can read the result instead of seeing raw headings, pipes, and asterisks.
One file to one review link
npm$ npx @viewable/cli share ./report.md
✓ Markdown ready to review
Input: report.md. Output: a private URL and a separate access code.
Preserve useful document structure.
Headings, lists, links, tables, code blocks, task lists, and other common GitHub-flavored Markdown elements render as a structured page rather than an unformatted text attachment.
Share only the finished artifact.
Viewable uploads the document you selected. It does not automatically include other local files, terminal history, prompts, or the rest of the agent session.
Workflow
From local file to human review.
- 01
Finish the document
Choose the plan, report, brief, or research note that is ready for another person to read. One share accepts one Markdown file up to 5 MiB.
- 02
Create the link
Run the share command. Viewable uploads the selected file and returns a private URL plus a separate access code.
- 03
Hand off the result
Send the URL and code to the reviewer. They open a formatted document in their browser without creating a Viewable account.
Details
What to know before sharing.
- Which Markdown features render?
- Viewable supports common Markdown and GitHub-flavored Markdown, including tables, task lists, fenced code blocks, links, and strikethrough.
- Can the recipient edit the source?
- No. The current review page is a readable handoff, not a collaborative editor or inline-commenting system.
- Is the page public?
- Each share uses a hard-to-guess URL plus an access code. Treat both as private access information and send them only to the intended recipient.
- Can I update it later?
- The CLI can update an existing Viewable share by share ID, keeping the same review URL while creating a new version.
Related guides