Ship a preview from VS Code without leaving the editor
Use the PreviewShip VS Code extension to authenticate once and deploy build output or an active HTML, Markdown, or PDF file to a live URL.
Answer First
PreviewShip VS Code extension is built for developers who want a shareable URL without switching to a hosting dashboard. Install the extension, save your API key, and deploy static build output or the current HTML, Markdown, or PDF file when it is ready for review.
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
Recommended workflow
Install the extension with `ext install previewship.previewship`.
Run “PreviewShip: Set API Key” from the command palette.
Open the project folder you want to share.
Run “PreviewShip: Deploy Workspace, HTML, Markdown, or PDF File” or “PreviewShip: Deploy Active HTML, Markdown, or PDF File” to generate the live URL.
What this removes from the workflow
VS Code deployment removes the manual steps that often slow review cycles: zipping files, opening a dashboard, creating a project, and copying upload artifacts around.
For small frontend changes, that reduction in friction often matters more than deeper production-hosting features.
Where VS Code deploys are most useful
This flow works best for prototypes, staging previews, internal review, AI-generated HTML, Markdown, PDF documents, and any situation where the main job is to share the current artifact quickly.
For framework projects, run the build first and deploy the generated static output rather than raw source files.
FAQ
Does PreviewShip replace production hosting inside VS Code?
No. It is optimized for preview sharing rather than full production hosting and infrastructure management.
Can non-Git projects use the VS Code extension?
Yes. PreviewShip does not require a connected repository to create a preview URL.
Can I deploy a single HTML, Markdown, or PDF file from VS Code?
Yes. Open the .html, Markdown, or .pdf file and run PreviewShip: Deploy Active HTML, Markdown, or PDF File. HTML and Markdown get web entry pages; PDF opens in a browser-native full-screen reader.
Can I use the extension offline?
The extension can be installed from a VSIX package, but deployment still requires access to PreviewShip services to upload and publish the build.