Overview
Use GitHub embeds to add a repository preview or a preview of a GitHub issue or pull request to a page or board card. Repository embeds show a GitHub repository card, while issue and pull request embeds include live metadata.
Keep project links near your notes, then open the repository or item on GitHub when you need more detail. Issue and pull request previews show states such as Open, Closed, Merged, or Draft when available.
When to use it
Keep a repository link beside notes about a project or codebase.
Add an issue preview to notes about a bug or task.
Include a pull request preview in a page tracking code review.
Put GitHub project links on a board card to keep them with related work.
Features and settings
Setting
GitHub link
Set the GitHub URL for the preview. Use a repository URL for a repository card, or an issue or pull request URL for its preview.
Built in
Repository previews
Embed a GitHub repository card and use Open Repo to visit the repository.
Built in
Issue and pull request previews
Preview a GitHub issue or pull request with live metadata, including a visible state such as Open, Closed, Merged, or Draft.
Built in
Open the original or refresh the preview
Use Open on GitHub to visit the linked item, or Refresh preview to reload its preview.
How to use it
Add a GitHub embed
Add the GitHub embeds block to a page or board card.
Choose what to preview
Use a repository embed for a repository, or an issue or pull request embed for a specific GitHub item.
Enter the GitHub link
For a repository, use Paste GitHub Repo URL (e.g. facebook/react)... and select Embed. For an issue or pull request, enter its URL in Paste a GitHub issue or pull request URL...
Manage the preview
Open GitHub preview settings to manage the preview. Select Refresh preview to reload it, or Open on GitHub to visit the original.
Where it works
On any page
In the / menu
Inside board cards
Turn other blocks into it
Own settings panel
Lara can add it for you
Examples
Project repository notes
Embed a repository beside planning notes so you can open the codebase from the same page.
Bug investigation
Add an issue preview to notes about a bug, keeping its GitHub link and live metadata nearby.
Pull request review
Place a pull request preview on a board card to keep the review link with related work.
Tips · Limitations
Tips
Use the repository URL for a repository card and an issue or pull request URL for an item preview.
Select Refresh preview when you want to reload an issue or pull request preview.
Use Open Repo or Open on GitHub to visit the linked GitHub page.
Limitations
An issue or pull request preview requires a valid HTTPS GitHub link.
The block is not available from the slash menu.
You can't convert a GitHub embed into another block.
Frequently asked questions
How do I embed a GitHub repository in my notes?
Add a GitHub repository embed, enter the repository URL in Paste GitHub Repo URL (e.g. facebook/react)..., and select Embed.
Can I embed a GitHub issue or pull request?
Yes. Add an issue or pull request embed and enter its GitHub URL in Paste a GitHub issue or pull request URL...
Does a GitHub issue or pull request preview show its status?
The preview includes live metadata and can show states such as Open, Closed, Merged, or Draft.
How do I refresh a GitHub preview?
Open GitHub preview settings and select Refresh preview.
How do I open the original GitHub page?
Select Open Repo for a repository preview or Open on GitHub for an issue or pull request preview.
Build your next page with GitHub embeds
Open Workspace, type / and add it in a second. Free to start, no credit card.