nbgitpuller documentation

  • Installation
  • Using nbgitpuller
  • Contributing
  • Automatic Merging Behavior
  • Options in an nbgitpuller URL
  • Content git repository best practices
  • nbgitpuller link generator
Theme by the Executable Book Project

nbgitpuller link generator¶

Use the following form to create your own nbgitpuller links.

Note

Consider using the nbgitpuller link generator browser extension instead! Available for Firefox and Chrome.

  • JupyterHub
  • Launch from Canvas
  • Binder
Must be a valid web URL
The JupyterHub to send users to. nbgitpuller must be installed in this hub.
Must be a valid git URL
The environment repository must have nbgitpuller installed.
branch
Use main instead of master for new GitHub repositories
Must specify a branch name
Must be a valid git URL
branch
This file or directory from within the repo will open when user clicks the link.



Pre-populating some fields in the link generator

You can pre-populate some fields in order to make it easier for some users to create their own links. To do so, use the following URL parameters when accessing this page:

  • hub is the URL of a JupyterHub

  • repo is the URL of a github repository to which you’re linking

  • branch is the branch you wish to pull from the Repository

For example, the following URL will pre-populate the form with the UC Berkeley DataHub as the JupyterHub:

https://jupyterhub.github.io/nbgitpuller/link?hub=https://datahub.berkeley.edu

Activating a tab when someone lands on this page

You can also activate one of the tabs in the form above by default when a user lands on this page. To do so, use the tab= REST parameter. Here are the possible values:

  • ?tab=binder - activates the Binder tab

  • ?tab=canvas - activates the Canvas tab.

previous

Content git repository best practices

By The nbgitpuller Team
© Copyright 2021, The nbgitpuller Team.