Skip to main content

Enable your Github repository

This guide will help you make a Github repository Notebook.link ready.

Notebook.link can be used to serve Github repositories content, allowing you to easily share your Notebooks with tutorials, classes content, live documentation etc.

Make sure the Github repository does not exceed the size limit​

The Github repository size is limited to 20MB, make sure your repository does not exceed this limit.

Define the environment​

Notebook.link requires that you provide the environment definition needed to run notebooks contained in the Github repository. See the Environment creation documentation for available features and limitations.

tip

The environment.yml file must be located under .nblink/environment.yml in your repository, or at the root.

Provide a lock file​

In order to make your environment more stable through time, you can provide a lock file to make sure the packages versions are pinned.

Such lock file content can be generated from the Environment Creation page by providing your environment.yml content, then click on the "Copy" button to get the lock content. This should be saved as a nblink-lock.json or .nblink/nblink-lock.json file in the repository.

Provide a custom JupyterLite config​

It's also possible to provide your own JupyterLite runtime config. This can be useful if you'd like to disable some labextensions.

{
  "jupyter-lite-schema-version": 0,
  "jupyter-config-data": {
    "appName": "My Amazing Notebook.link demo",
    "disabledExtensions": ["@jupyterlab/application-extension:logo"]
  }
}

Read the jupyterlite documentation for more information.

About private Github repositories​

It is possible to expose links to your private repositories by installing the Notebook.link Github app on your Github account.

This application has access to your private repositories content, and can expose their content through shared links.

danger

Be mindful that after installing this app, anyone with a Notebook link pointing to your private repository will be able to see and download its content.

note

Once installed, you can only create links by commit hash. Read more about how to create links.