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 by clicking the New Link button, as shown in 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

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.