Support custom hypothesis client url

fixes #4840
quarto-dev · Dec 6, 2023 · a2b6663 · a2b6663
1 parent cf783ff
commit a2b6663
Show file tree

Hide file tree

Showing 7 changed files with 33 additions and 10 deletions.
diff --git a/news/changelog-1.4.md b/news/changelog-1.4.md
@@ -19,6 +19,7 @@
 - Add support for showing cross reference contents on hover (use `crossrefs-hover: false` to disable).
 - Add support for displaying `keywords` in HTML page title block, when present.
 - ([#3473](https://github.com/quarto-dev/quarto-cli/issues/3473)): Add support for `body-right` and `body-left` layouts for Website Table of Contents.
+- ([#4840](https://github.com/quarto-dev/quarto-cli/issues/4840)): Add support for specifying a custom Hypothesis client url using `client-url`
 - ([#4882](https://github.com/quarto-dev/quarto-cli/issues/4882)): Add support for `canonical-url`, which when provided will include a link tag with rel='canonical' which will use an explictly provided or automatically generated canonical url for the document.
 - ([#5189](https://github.com/quarto-dev/quarto-cli/issues/5189)): Ensure appendix shows even when `page-layout` is custom.
 - ([#5210](https://github.com/quarto-dev/quarto-cli/issues/5210)): Update to Bootstrap 5.2.2

diff --git a/src/resources/editor/tools/vs-code.mjs b/src/resources/editor/tools/vs-code.mjs
@@ -8697,6 +8697,11 @@ var require_yaml_intelligence_resources = __commonJS({
                         object: {
                           closed: true,
                           properties: {
+                            "client-url": {
+                              string: {
+                                description: "Override the default hypothesis client url with a custom client url."
+                              }
+                            },
                             openSidebar: {
                               boolean: {
                                 default: false,
@@ -22581,12 +22586,12 @@ var require_yaml_intelligence_resources = __commonJS({
         mermaid: "%%"
       },
       "handlers/mermaid/schema.yml": {
-        _internalId: 180637,
+        _internalId: 180639,
         type: "object",
         description: "be an object",
         properties: {
           "mermaid-format": {
-            _internalId: 180629,
+            _internalId: 180631,
             type: "enum",
             enum: [
               "png",
@@ -22602,7 +22607,7 @@ var require_yaml_intelligence_resources = __commonJS({
             exhaustiveCompletions: true
           },
           theme: {
-            _internalId: 180636,
+            _internalId: 180638,
             type: "anyOf",
             anyOf: [
               {

diff --git a/src/resources/editor/tools/yaml/web-worker.js b/src/resources/editor/tools/yaml/web-worker.js
diff --git a/src/resources/editor/tools/yaml/yaml-intelligence-resources.json b/src/resources/editor/tools/yaml/yaml-intelligence-resources.json
@@ -1669,6 +1669,11 @@
                     "object": {
                       "closed": true,
                       "properties": {
+                        "client-url": {
+                          "string": {
+                            "description": "Override the default hypothesis client url with a custom client url."
+                          }
+                        },
                         "openSidebar": {
                           "boolean": {
                             "default": false,
@@ -15553,12 +15558,12 @@
     "mermaid": "%%"
   },
   "handlers/mermaid/schema.yml": {
-    "_internalId": 180637,
+    "_internalId": 180639,
     "type": "object",
     "description": "be an object",
     "properties": {
       "mermaid-format": {
-        "_internalId": 180629,
+        "_internalId": 180631,
         "type": "enum",
         "enum": [
           "png",
@@ -15574,7 +15579,7 @@
         "exhaustiveCompletions": true
       },
       "theme": {
-        "_internalId": 180636,
+        "_internalId": 180638,
         "type": "anyOf",
         "anyOf": [
           {

diff --git a/src/resources/formats/html/hypothesis/hypothesis.ejs b/src/resources/formats/html/hypothesis/hypothesis.ejs
@@ -1,9 +1,11 @@
+<% let srcHref = "https://hypothes.is/embed.js"; %>
 <% if (typeof(hypothesis) === "object") { %>
+  <% if (hypothesis['client-url']) { srcHref = hypothesis['client-url']; } %>
 <script type="application/json" class="js-hypothesis-config">
 <%= JSON.stringify(hypothesis, undefined, 2) %>
 </script>
 <% } %>
-<script async src="https://hypothes.is/embed.js"></script>
+<script async src="<%= srcHref %>"></script>
 <script>
   window.document.addEventListener("DOMContentLoaded", function (_event) {
     document.body.classList.add('hypothesis-enabled');

diff --git a/src/resources/schema/definitions.yml b/src/resources/schema/definitions.yml
@@ -303,6 +303,9 @@
               - object:
                   closed: true
                   properties:
+                    client-url:
+                      string:
+                        description: Override the default hypothesis client url with a custom client url.
                     openSidebar:
                       boolean:
                         default: false

diff --git a/src/resources/types/schema-types.ts b/src/resources/types/schema-types.ts
@@ -148,6 +148,8 @@ the discussions feature must be enabled. */;
       }; /* The giscus theme to use when displaying comments. */
   };
   hypothesis?: boolean | {
+    "client-url"?:
+      string /* Override the default hypothesis client url with a custom client url. */;
     assetRoot?: string /* The root URL from which assets are loaded. */;
     branding?: {
       accentColor?: