Added support for specifying copied text for code blocks

squidfunk · Oct 5, 2023 · a9da0b6 · a9da0b6
1 parent 48ff39a
commit a9da0b6
Show file tree

Hide file tree

Showing 5 changed files with 41 additions and 7 deletions.
diff --git a/docs/reference/code-blocks.md b/docs/reference/code-blocks.md
@@ -81,6 +81,37 @@ theme:
     ```
     ````
 
+??? tip "Overriding the clipboard text"
+
+    If you want to define a slightly different text to be copied to the
+    clipboard, you can use the `data-copy` attribute on the code block. Note
+    that this attribute does not support multiple lines, which is not a
+    limitation of Material for MkDocs, but of the Markdown parser. Example:
+
+    ```` markdown title="Code block"
+    ``` { .sh data-copy="curl https://www.example.com" }
+    $ curl https://www.example.com
+    # <!doctype html>
+    #   <html>
+    # ...
+    ```
+    ````
+
+    <div class="result" markdown>
+
+    ``` { .sh data-copy="curl https://www.example.com" }
+    $ curl https://www.example.com
+    # <!doctype html>
+    #   <html>
+    # ...
+    ```
+
+    </div>
+
+    We recommend to use this very sparingly, because sometimes it can be
+    confusing to copy something different to the clipboard than what is
+    actually displayed.
+
 ### Code selection button
 
 <!-- md:sponsors -->

diff --git a/...assets/javascripts/bundle.2a9e8380.min.js → ...assets/javascripts/bundle.94c44541.min.js b/...assets/javascripts/bundle.2a9e8380.min.js → ...assets/javascripts/bundle.94c44541.min.js
diff --git a/...ts/javascripts/bundle.2a9e8380.min.js.map → ...ts/javascripts/bundle.94c44541.min.js.map b/...ts/javascripts/bundle.2a9e8380.min.js.map → ...ts/javascripts/bundle.94c44541.min.js.map
diff --git a/material/templates/base.html b/material/templates/base.html
@@ -249,7 +249,7 @@
       </script>
     {% endblock %}
     {% block scripts %}
-      <script src="{{ 'assets/javascripts/bundle.2a9e8380.min.js' | url }}"></script>
+      <script src="{{ 'assets/javascripts/bundle.94c44541.min.js' | url }}"></script>
       {% for script in config.extra_javascript %}
         {{ script | script_tag }}
       {% endfor %}

diff --git a/src/templates/assets/javascripts/integrations/clipboard/index.ts b/src/templates/assets/javascripts/integrations/clipboard/index.ts
@@ -55,7 +55,10 @@ interface SetupOptions {
  */
 function extract(el: HTMLElement): string {
   el.setAttribute("data-md-copying", "")
-  const text = el.getAttribute("data-clipboard-text") ?? el.innerText
+  const copy = el.closest("[data-copy]")
+  const text = copy
+    ? copy.getAttribute("data-copy")!
+    : el.innerText
   el.removeAttribute("data-md-copying")
   return text
 }