Skip to main content

Create a Notebook link

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

Currently, with Notebook.link, you can set the visibility of your links: it defines if they are shown on your profile page or user feed. They can be:

  • public (public URL and shown in the feed)
  • unlisted (public URL but hidden from user's feed).

When creating a new link, you can set the visibility using the dedicated dropdown at the bottom of the New link panel. To update the visibility status of an existing link, just edit the link and use the dropdown in the Edit link panel (as shown in the video below).

Make your own!​

With a public Git repository URL​

Easily share Jupyter Notebooks from a Git repository with Notebook.link, without even opening its dashboard.

Simply prefix the repository URL with notebook.link. This works with any public repository hosted on a supported Git provider, 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).

You will be redirected to the canonical form of the link, https://notebook.link/github/matplotlib/ipympl/.

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

Each Git provider has its own URL format and limitations, see Supported Git providers.

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 Git 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 Git Repository​

First, make sure your 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 Git provider hosting the repository
  • the repository path from which to create the link, as shown in the form placeholder (e.g. owner/repo)
  • the git reference to make the snapshot from: a commit, a branch, a tag, or a pull/merge request number

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

Interface style​

You can select between different interface styles as shown in the following video:

  • 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.