Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

✨ NEW: Add Launch in Deepnote button setting #1434

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/_config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ launch_buttons:
notebook_interface: "classic" # The interface interactive links will activate ["classic", "jupyterlab"]
binderhub_url: "https://mybinder.org"
colab_url: "https://colab.research.google.com"
deepnote_url: "https://deepnote.com"
thebe: true

parse:
Expand Down
25 changes: 24 additions & 1 deletion docs/interactive/launchbuttons.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,30 @@
"```{note}\n",
"Google Colab links will only work for pages that have the `.ipynb` extension.\n",
"```"
]
],
"cell_type": "markdown",
"metadata": {}
},
{
"source": [
"## Add a Launch in {term}`Deepnote` button\n",
"\n",
"If your Jupyter Book is hosted online on GitHub, you can automatically insert buttons that link to the Jupyter Notebook running on [Deepnote](https://deepnote.com/).\n",
"When a user clicks the button, they'll be taken to a live version of the page.\n",
"\n",
"Similar to Binder and Colab link buttons, you can automatically include Deepnote link buttons with the following configuration in `_config.yml`:\n",
"\n",
"```yaml\n",
"launch_buttons:\n",
" colab_url: \"https://deepnote.com\"\n",
"```\n",
"\n",
"```{note}\n",
"Deepnote links will only work for pages that have the `.ipynb` extension.\n",
"```"
],
"cell_type": "markdown",
"metadata": {}
}
],
"metadata": {
Expand Down
3 changes: 3 additions & 0 deletions jupyter_book/config_schema.json
Original file line number Diff line number Diff line change
Expand Up @@ -171,6 +171,9 @@
},
"colab_url": {
"type": "string"
},
"deepnote_url": {
"type": "string"
}
}
},
Expand Down
1 change: 1 addition & 0 deletions jupyter_book/default_config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,7 @@ launch_buttons:
jupyterhub_url : "" # The URL of the JupyterHub (e.g., https://datahub.berkeley.edu)
thebe : false # Add a thebe button to pages (requires the repository to run on Binder)
colab_url : "" # The URL of Google Colab (https://colab.research.google.com)
deepnote_url : "" # The URL of Deepnote (https://deepnote.com)

repository:
url : https://github.com/executablebooks/jupyter-book # The URL to your book's repository
Expand Down