Skip to main content

Create a Notebook link

Notebook links are future-proof shareable links to project or Github repository "snapshots".

Make your own!​

From the Link page, you can create a new link clicking the New Link button, as shown on the following video:

You can create two types of links:

  • From a Project Snapshot: create a link from a snapshot of the project at a given time
  • From a Repository: create a link from a snapshot of a repository at a given time

In order to create a link, you will need:

  • a name for the link. This name is only visible to you.
  • (Optional) a document path if you want a specific file to be opened by default.
  • (Optional, defaults to "Lab") the application to use by default: either JupyterLab or Jupyter Notebook
  • (Optional) an alias, helping you to make your link shorter and more user-friendly. e.g. the link URL becomes https://notebook.link/@{username}/{alias}.

From Project Snapshot​

To create a link from a project, you'd need to additionally provide:

  • the project name from which to create the link
  • the timestamp of the snapshot

From the New Link form, select From Project Snapshot.

From a GitHub Repository​

First, make sure your Github repository is Notebook.link ready.

tip

In order to make your link future-proof, we highly recommend providing a lock file in your repository as explained in the documentation page linked above.

To create a link from a repository, you'd need to additionally provide:

  • the repository URL from which to create the link
  • the git commit, tag or branch to make the snapshot from

Then, from the New Link form, you can create a link from that repository.