Using pr.new
This page covers using pr.new to open, view, and contribute to any project through our Codeflow IDE or Web Publisher.
Built to make open source contributions as easy as possible. 🥰
What is pr.new?
pr.new is a short URL that can be used on any repository to explore code, a branch or an issue, to review a PR, or even to edit a file, all in a live environment with a realtime preview.
How does pr.new work?
Behind the scenes, this short URL will choose different tools in different scenarios:
Opening a GitHub repository
To open a GitHub repository with pr.new, visit it on GitHub and in the browser's address tab, add pr.new to the beginning of the URL, for example:
You will be redirected to Codeflow IDE where you can work to submit a PR or just explore the codebase.
Opening a specific branch
To inspect a branch with pr.new, visit it on GitHub and in the browser's address tab, add pr.new to the beginning of the URL, for example:
pr.new/github.com/stackblitz/docs/tree/BRANCH-NAME
You will be redirected to Codeflow IDE where you can explore the code, continue the work, or investigate the issue.
Reviewing a PR
To review a PR with pr.new, visit the submitted pull request on GitHub and in the browser's address tab, add pr.new to the beginning of the URL, for example:
You will be redirected to Codeflow IDE in the "PR review mode" where you will see diffs. You can switch to the standard file view by choosing the "file" icon in the left vertical nav bar.
"Open in Codeflow" button
To help your users quickly spin up the entire environment with your project, you can add a CTA (call-to-action) button on your website or in the README file with any of the above pr.new links.
| Button preview | Direct URL |
|---|---|
 | open_in_codeflow.svg |
 | open_in_codeflow_small.svg |
TIP
You can either host the images on your servers or directly use our image URLs.
In order to display the button in a Markdown file, use the following code - remember to update the last URL with the project repository path:
[](https:///pr.new/___GH_ACCOUNT__/___GH_REPOSITORY___)Or, in HTML:
<a href="https:///pr.new/___GH_ACCOUNT__/___GH_REPOSITORY___">
<img
alt="Open in Codeflow"
src="https://developer.stackblitz.com/img/open_in_codeflow.svg"
/>
</a>If the user is logged in at GitHub and StackBlitz (in beta), Codeflow IDE will open up. No further configuration is needed.
Opening a single file
To edit a single file with pr.new, visit it in the GitHub repository and click the "Edit" icon (a pencil). Now, in the browser's address tab, add pr.new to the beginning of the URL, for example:
pr.new/github.com/stackblitz/docs/edit/main/docs/guides/user-guide/what-is-stackblitz.md
You will be redirected to Web Publisher for a more pleasant editing experience. If you prefer to work in a full environment, click on the "Open in IDE" button and you will be redirected to Codeflow IDE.