Guide / Markdown

Turn Markdown into a website preview

Publish Markdown as a browser-ready preview page for docs, reports, AI outputs, specs, and client review links.

Updated 2026-06-22Practical deployment guide

Answer First

PreviewShip can publish Markdown directly. Upload a .md/.markdown file, paste Markdown in the deploy page, or deploy a Markdown file with CLI/MCP. PreviewShip packages it with a safe viewer and returns a shareable preview URL.

Try without signing up Read full docs

Deploy build artifacts, not source-code zips.

If you upload a zip, build the project first and zip the static output folder such as dist, build, out, or public with index.html and assets. Do not zip raw React/Vue/Next source folders with package.json and node_modules. Single .html, .md/.markdown, and .pdf files are supported directly by console upload, CLI, MCP, and the VS Code/Cursor extension.

Key takeaways

Markdown deploys are useful for AI reports, specs, docs, changelogs, and review notes.

You can publish without converting Markdown to HTML manually.

The same fixed project link can be updated with later Markdown versions.

Recommended workflow

Prepare a .md or .markdown file, or paste Markdown into the deploy page.

Deploy it through the browser, CLI, MCP, VS Code, or Cursor workflow.

Open the generated preview URL to verify formatting.

Share the link or claim the guest project to keep the URL.

Comparison snapshot

Question	PreviewShip Markdown	Manual conversion
Input	.md file or pasted Markdown	Convert to HTML first
Share model	Hosted preview URL	Attachment or local file
Repeat deploys	Fixed project link	Often new exported files
Agent fit	CLI/MCP supported	Manual handoff

Best Markdown use cases

Markdown is common for AI-generated reports, implementation notes, README drafts, specs, changelogs, and lightweight documentation. A preview URL makes that content easier to review than a raw file attachment.

AI research reports

Product specs and PRDs

Release notes and changelogs

Client-facing documentation drafts

When to switch to HTML

Use HTML when the output needs custom styling, scripts, embeds, or interactive widgets. Use Markdown when the main value is readable structured text.

FAQ

Can I upload Markdown directly?

Yes. PreviewShip supports .md and .markdown uploads, pasted Markdown, CLI deploys, and MCP deploys.

Will the Markdown URL stay the same after redeploying?

Yes, when you deploy to the same project. The fixed project link points to the latest deployment.

Is Markdown indexed in Showcase?

Public Showcase items become indexable automatically when they have a descriptive title, useful description, cover, tags, and a ready preview. Private, password-protected, thin, duplicate, expired, or removed previews are excluded.