0
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

More than 1 year has passed since last update.

SvelteKitプロジェクト内でのMarkdownにおいてLaTeXを使う

Posted at

概要

タイトルの通りです.

自作ブログでMarkdownを記事にするところまでできたのですが, ついでに$\LaTeX$を書けるようにしてみました.
めちゃくちゃ簡単で, 便利な世の中だと思いました(小並感).
せっかくなのでやったことだけ書いておこうと思います.

Markdownファイルをページとして扱う

これはこの記事と本来は関係ないため備忘録程度にしておきます.

mdsvexというパッケージを使います(読み方がわからん).
ここ(公式ドキュメント)とここ(詳しくブログ的な使い方が記載されている)に書いてあることを読めばいいです.
私は最初は後者の記事をほぼ写しました.

LaTeX表示のために使用したライブラリ

とりあえず, 順番に列挙していこうと思います.

KaTeX

ウェブ上でLaTeXを書きたいときにはMathJaxが有名と思いますが, おそらく後発のKaTeXというものもあります.
Qiitaとかでも使われているらしいです.
高速, 見た目の質, 依存性のなさ等で優れているようです.

Remark

RemarkはMarkdownプロセッサであり, unifiedというプロジェクトの一部という位置づけのようです.

unifiedはテキストと抽象構文木を関連付けて操作するライブラリ全般を扱うようです.
その中で, Markdownの文法に対応したものがremarkだと理解しました.

関連ライブラリが様々にあるようで, 処理自体に影響を与えるもの, 構造要素に色々味付けができるもの, 他の構造化文書に変換するものなど多岐にわたります.

rehype

これもunifiedプロジェクトの一部です.

こちらはHTML処理を担当するようで, 思想はremarkと似ています.
remarkと組み合わせて美味しいことができそうな感じがします.
こちらも大量に関連ライブラリがあります.

mdsvex

前節にも登場しました.
SvelteのConfigファイルでこれをプリプロセッサとして書いてあげると, ビルド時にマークダウンファイルをよしなにSvelteの要素として扱ってくれます.

このmdsvexは上記のremarkrehypeをさらに中で走らせることができます.
つまり, markdownを読みこんだときにremarkで処理したり, 処理したhtmlをrehypeで処理したりできます.
好きな機能を選んで使えることになります.

結局使ったもの

というわけでその中で使ったのが以下です.

remark-mathは, markdown中の$\LaTeX$構文をunifiedで扱える構造に置き換えるものです(だと思っています).
rehype-katex-svelteは, rehype-katexというプラグインをSvelteで扱えるようにチューニングされたものです(公式のrehypeプラグインとはなっていないようです).
rehype-katexは適当なunified構造をKaTeXを用いてマークアップするものです.

ここまでで, できそうな気がしてきました.

Svelteにおける設定

あとはほとんど用意してもらった構造を使うだけです.

svelte.config.jsを以下のようにセットします.

import { mdsvex } from "mdsvex";
import rehypeKatexSvelte from "rehype-katex-svelte";
import remarkMath from "remark-math";

const config = {
  preprocess: [
    preprocess(),
    mdsvex({
      extensions: [".md"],
      remarkPlugins: [remarkMath],
      rehypePlugins: [rehypeKatexSvelte]
    })
  ],
  ...
}

のようにします.
これで, markdown中に$\LaTeX$と書けば$\LaTeX$となります.

ディスプレイ数式も,

$$
\\frac{1}{c^2}\ddot{u}(x, t) - u_{,ii}(x,t) = 0, \\quad x\\in D, t>0
$$

でOKです.

$$
\frac{1}{c^2}\ddot{u}(x, t) - u_{,ii}(x,t) = 0, \quad x\in D, t>0
$$

となります.
なお, Qiitaではうまく表示されませんが\\bm{x}などとすれば正しく表示されるようです.

余談

その1

mdsvexはPrism.jsを内包しているようで, コードブロックを見つけると自動で要素に分解してクラスを付与してくれます.
Prismのテーマを適当にダウンロードして使うようにしてやれば, いい感じにコードを掲載できます.
すごい.

その2

今, 目次を自動で生成するようにしたいと考えています.

これもrehypeを使います.
rehype-slugというやつをpreprocessorに挟むと各見出しにidを付与してくれます(これをslugというそうです).

で, rehype-tocというやつでslugがついている見出しをいい感じのhtmlにまとめて冒頭にくっつけてくれます.

これだけでできそうな気がするのですが, Svelteのビルドで弾かれてしまいます.
というのも, Svelteはリンクが壊れていないかどうかを巡回して確かめてくれるのですが, rehype系は日本語をそのまま扱うのに対してSvelteはURLエンコードをしてからチェックするようです.

例えば, 「テスト」という見出しについて考えます.
これをURLエンコードすると%E3%83%86%E3%82%B9%E3%83%88となります.
rehype-slug<h2 id="テスト">テスト</h2>という要素を生成し, rehype-tocもこれに従って<a href="#テスト">のようなリンクを生成します.
しかし, Svelteは「idが%E3%83%86%E3%82%B9%E3%83%88っていう要素がないよ」と警告を出し, ビルドできません.

実は, rehype-slug側のコードをいじったら解決した(要素にidを挟んでいるだけのすごく簡単なコードでできているので, ここにURLエンコードを挟むだけで解決しました)のですが, GitHub Actionsで自動ビルドするのには使えません.

というわけで, Issueを立てるかプルリクエストなどと迷っていますが全く何をすればいいかわかりません.
だれか手ほどきしてくれ〜

まとめ

というわけでSvelteKitで作ったブログで$\LaTeX$記法を使えるようになりました.
仕組みとかをあまり理解していないのでもうちょっと親しめたらいいと思います.

0
0
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
0
0

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?