blogPosts/remark-math.md at main

moris/blogPosts

Fork 0

moris a549d7d017 New article✨: remark-math

2024-12-22 11:45:15 +09:00

5.5 KiB

Raw Permalink Blame History

title

description

thumbnail

emoji

date

remark-math

remark-mathというunifiedプラグインを使用してTeX記法での数式に対応しました。 https://github.com/remarkjs/remark-math

この辺りは詳しくないのですが、ブラウザで数式を表示するエンジンとしてMathJaxとKaTeXが主に使われているようで、remark-mathはその2つに対応しています。 KaTeXの方が軽量らしいのでそちらを採用することに(サーバーサイドレンダリングには無関係かも)

使い方は他のプラグイン同様にインストールしてuse()で追加するのですが、2つ追加する必要があります。一つ目はremark-mathで、これを適用するとTeX記法の部分がlang=mathのコードブロック(```で囲うやつ)に変換されます。そして、二つ目のrehype-katex(MathJaxの場合はrehype-mathjax)がこれを数式に変換します。そのため以下のような記法でも数式に変換することができます。

```math

e = mc^2

```

サンプルコード

npm install remark remark-rehype rehype-stringify

npm install remark-math
npm install rehype-katex    // KaTeXの場合
npm install rehype-mathjax  // MathJaxの場合(コードもいい感じに置き換えてね)

import { remark } from 'remark'
import remarkmath from 'remark-math'
import remarkRehype from 'remark-rehype'
import rehypeKatex from 'rehype-katex'
import rehypeStringify from 'rehype-stringify'

let markdown = "$e=mc^2$"

let html = remark()
    .use(remarkmath)
    .use(remarkRehype)
    .use(rehypeKatex)
    .use(rehypeStringify)
    .processSync(markdown)

console.log(String(html))

Output:

<p><span class="katex"><span class="katex-mathml"><math xmlns="http://www.w3.org/1998/Math/MathML"><semantics><mrow><mi>e</mi><mo>=</mo><mi>m</mi><msup><mi>c</mi><mn>2</mn></msup></mrow><annotation encoding="application/x-tex">e=mc^2</annotation></semantics></math></span><span class="katex-html" aria-hidden="true"><span class="base"><span class="strut" style="height:0.4306em;"></span><span class="mord mathnormal">e</span><span class="mspace" style="margin-right:0.2778em;"></span><span class="mrel">=</span><span class="mspace" style="margin-right:0.2778em;"></span></span><span class="base"><span class="strut" style="height:0.8141em;"></span><span class="mord mathnormal">m</span><span class="mord"><span class="mord mathnormal">c</span><span class="msupsub"><span class="vlist-t"><span class="vlist-r"><span class="vlist" style="height:0.8141em;"><span style="top:-3.063em;margin-right:0.05em;"><span class="pstrut" style="height:2.7em;"></span><span class="sizing reset-size6 size3 mtight"><span class="mord mtight">2</span></span></span></span></span></span></span></span></span></span></span></p>

実行するとhtmlが出てくるのですが、そのまま.htmlで保存してブラウザで開くと、ダブってるし片方は数式になっていません。これだけではダメでKaTeXでは追加のCSSを適用する必要があるのです。(MathJaxではCSSが一緒に出力されるので不要) なので以下のlinkタグを追加して再度開くと

<link href="https://cdn.jsdelivr.net/npm/katex@0.16.11/dist/katex.min.css" rel="stylesheet">

数式として表示されました✨

オプション(MathMLで出力)

KaTeXはhtml(+css)とMathMLという形式の出力に対応しています。 MathMLとは簡単にいうとSVGの数式版のようなもので、数式を記述するためのxmlマークアップです。 SVGと同様にwebブラウザで表示が可能ですが最近まではサポートが微妙だったため現時点ではMDNでもNEWLY AVAILABLEとなっています。(https://developer.mozilla.org/ja/docs/Web/MathML)

KaTeXではhtmlのみを出力、MathMLのみを出力、htmlを表示してMathMLをアクセシビリティのために不可視で付ける、の3種類が選択可能で3つ目がデフォルトになっています。(ちなみにcssをつけないとダブるのはこのためです。) 自分はcssを付けたくなかったためMathMLにしました。そのため以下のようにオプションを設定しています。

.use(rehypeKatex, {output:'mathml'})

そのほかのオプションはKaTeXのサイトで確認できます。 https://katex.org/docs/options.html

このブログのMarkdown周りのコードはここです。 https://git.moris.day/moris/moris-blog/src/branch/main/src/lib/components/Markdown.svelte

おまけの数式

二次方程式解の公式


x = \frac{-b\pm \sqrt{b^2-4ac}}{2a}

クーロンの法則


F=k_0{q_1q_2 \over r^2} = {1 \over 4\pi\epsilon_0}{q_1q_2 \over r^2}

5.5 KiB Raw Permalink Blame History

remark-math

オプション(MathMLで出力)

おまけの数式

5.5 KiB

Raw Permalink Blame History