mirror of
https://github.com/Smaug123/KaTeX
synced 2025-10-06 11:48:41 +00:00
49f84f76e7
* Remove RC-versioned docs * Release v0.10.0 Bump master to v0.10.1-pre * Fix multiple occuring hash replacement * Update SRI hashes * Update CHANGELOG.md * Fix tags not shown * Update docusaurus * Wrap escaping backslashes with backticks * Update SRI hashes * Update CHANGELOG.md
50 lines
2.4 KiB
Markdown
50 lines
2.4 KiB
Markdown
# Copy-tex extension
|
|
|
|
This extension modifes the copy/paste behavior in any browser supporting the
|
|
[Clipboard API](https://developer.mozilla.org/en-US/docs/Web/API/ClipboardEvent)
|
|
so that, when selecting and copying whole KaTeX-rendered elements, the text
|
|
content of the resulting clipboard renders KaTeX elements as their LaTeX source
|
|
surrounded by specified delimiters. (The HTML content of the resulting
|
|
clipboard remains the selected HTML content, as it normally would.)
|
|
The default delimiters are `$...$` for inline math and `$$...$$` for display
|
|
math, but you can easy switch them to e.g. `\(...\)` and `\[...\]` by
|
|
modifying `copyDelimiters` in [the source code](copy-tex.js).
|
|
|
|
### Usage
|
|
|
|
This extension isn't part of KaTeX proper, so the script should be separately
|
|
included in the page. It also provides *optional* custom CSS that
|
|
defines KaTeX equations as
|
|
[`user-select: all`](https://developer.mozilla.org/en-US/docs/Web/CSS/user-select)
|
|
so that they get selected all-or-nothing (and thus trigger the good behavior
|
|
provided by this extension). Without this CSS, partially selected equations
|
|
will just get the usual HTML copy/paste behavior.
|
|
|
|
```html
|
|
<link href="https://cdn.jsdelivr.net/npm/katex@0.10.0/dist/contrib/copy-tex.css" rel="stylesheet" type="text/css">
|
|
<script src="https://cdn.jsdelivr.net/npm/katex@0.10.0/dist/contrib/copy-tex.min.js" integrity="sha384-BU/ZjHp6l8sAdA5pVWg7PDyDWxlvDtRbesZdg6/WprhHmvgodUl4JKPQH/53jvNY" crossorigin="anonymous"></script>
|
|
```
|
|
|
|
See [index.html](index.html) for an example.
|
|
(To run this example from a clone of the repository, run `yarn start`
|
|
in the root KaTeX directory, and then visit
|
|
http://localhost:7936/contrib/copy-tex/index.html
|
|
with your web browser.)
|
|
|
|
If you want to build your own custom copy handler based on this one,
|
|
copy the `copy-tex.js` into your codebase and replace the `require`
|
|
statement with `require('katex/contrib/copy-tex/katex2tex.js')`.
|
|
|
|
### Known Issues
|
|
|
|
This extension has been tested on Chrome, Firefox, Edge, and Safari.
|
|
|
|
Microsoft Edge
|
|
[does not seem to support](https://developer.microsoft.com/en-us/microsoft-edge/platform/status/clipboardapi/)
|
|
text and HTML content in a single clipboard. In this browser, this extension
|
|
will just put the text content into the clipboard.
|
|
|
|
Safari copies correctly, but the selection rectangle renders strangely
|
|
(too big) when interacting with display math
|
|
(because of the `user-select: all` CSS).
|