Skip to main content

Create a Notebook link

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

Make your own!​

With a public GitHub URL​

Easily share Jupyter Notebooks from GitHub with Notebook.link, without even opening its dashboard.

Simply prefix the GitHub repository URL with notebook.link. This works with any repository but your repository must be Notebook.link ready for Notebook.link to fetch all dependencies relevant to the project. Otherwise you can still press "Continue" from the boot page to continue with the default environment containing just a Python kernel.

For example, take this GitHub repo: https://github.com/matplotlib/ipympl/.

By visiting https://notebook.link/github.com/matplotlib/ipympl/, you can open notebooks like docs/index.ipynb directly in Notebook.link (as shown in the video below).

By default, this will pull the latest commit of the default branch. You can also put any valid git reference (use the Github interface to navigate to the proper URL format), such as :

From the link page​

You can create new links directly from the Link page by clicking the New Link button, as demonstrated in the video below:

Two types of links are available:

  • Project Snapshot: generate a link from a snapshot of your project at a specific point in time.
  • Repository: generate a link from a snapshot of an entire repository at a given time.

When creating a link, you can configure:

  • Name of the link: this name is only visible to you.
  • (Optional) Document path: you can specify a file to be opened by default.
  • Interface style: Notebook link proposes three interface styles, as detailed in Interface style section
  • (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

To make your link future-proof, we strongly recommend including a lock file in your repository, as described in the documentation 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.

Interface style​

Your can select between different interface styles:

  • Windowed Interface (JupyterLab) : it refers to the JupyterLab UI featuring a multi-panel layout, which includes a file browser where you can access all notebooks and other project files. In the screencast below, you can see what it looks like when opening a link created with the windowed interface style
  • Single-document Interface: it is designed for use with Jupyter Notebooks or Jupyter applications with specific document type like JupyterGIS maps. When opening a link generated with this interface type, you are directed to a full-page file browser containing all notebooks and project files. Here, you can open your selected document as demonstrated in the screencasts below. The first video illustrates a notebook example, while the second demonstrates a JupyterGIS map.