Merge pull request #1434 from jakubzitny/deepnote-button

agoose77 · web-flow · commit ad69606dd6d1 · 2024-10-02T21:09:47.000+01:00
✨ NEW: Add Launch in Deepnote button setting
diff --git a/docs/_config.yml b/docs/_config.yml
@@ -44,6 +44,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:
diff --git a/docs/interactive/launchbuttons.ipynb b/docs/interactive/launchbuttons.ipynb
@@ -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": {
diff --git a/jupyter_book/config_schema.json b/jupyter_book/config_schema.json
@@ -181,6 +181,9 @@
         },
         "colab_url": {
           "type": "string"
+        },
+        "deepnote_url": {
+          "type": "string"
         }
       }
     },
diff --git a/jupyter_book/default_config.yml b/jupyter_book/default_config.yml
@@ -79,6 +79,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

Original file line number	Diff line number	Diff line change
`@@ -181,6 +181,9 @@`
`181`	`181`	`},`
`182`	`182`	`"colab_url": {`
`183`	`183`	`"type": "string"`
	`184`	`+ },`
	`185`	`+ "deepnote_url": {`
	`186`	`+ "type": "string"`
`184`	`187`	`}`
`185`	`188`	`}`
`186`	`189`	`},`