From 6fd01597b1ff6d69dce6ccd2b393533343cff461 Mon Sep 17 00:00:00 2001 From: Maxence Drutel Date: Tue, 23 Apr 2024 10:52:27 +0200 Subject: [PATCH] feat: Add latex support --- docs/javascripts/katex.js | 19 +++++++++++++++++++ mkdocs.yml | 8 ++++++++ 2 files changed, 27 insertions(+) create mode 100644 docs/javascripts/katex.js diff --git a/docs/javascripts/katex.js b/docs/javascripts/katex.js new file mode 100644 index 0000000..6da2abd --- /dev/null +++ b/docs/javascripts/katex.js @@ -0,0 +1,19 @@ +document$.subscribe(({ body }) => { + const macros = { + "\\dag": '\\dagger', + "\\dd": '\\mathrm{d}', + "\\dt": '\\mathrm{d}t', + "\\tr": "\\mathrm{Tr}\\left[#1\\right]", + "\\kett": "|#1\\rangle\\!\\rangle", + }; + + renderMathInElement(body, { + delimiters: [ + { left: "$$", right: "$$", display: true }, + { left: "$", right: "$", display: false }, + { left: "\\(", right: "\\)", display: false }, + { left: "\\[", right: "\\]", display: true } + ], + macros: macros, + }) +}); diff --git a/mkdocs.yml b/mkdocs.yml index e278719..0782cf9 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -27,5 +27,13 @@ nav: - About the Qiskit provider: about_api_providers/about_the_provider.md - Changelog: about_api_providers/changelog.md - Contact us: contact_us.md +markdown_extensions: + - pymdownx.arithmatex: + generic: true extra_css: - stylesheets/extra.css + - https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/katex.min.css +extra_javascript: + - javascripts/katex.js + - https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/katex.min.js + - https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/contrib/auto-render.min.js