More than 3 years have passed since last update.

GitHub の Issue などで数式を表示する

数学

Last updated at 2022-01-24Posted at 2020-06-01

本日は

インターネットの発展によって自分の学んだ事，知見を知って欲しいことを誰でも気軽に発信できるようになってきています．
Qiita では Markdown を用いることで構造化された文章を作成する事ができます．必要に応じてプログラムの知見をサンプルコードを通して行う事ができます．

# これは Julia のサンプルコードです．
function hello(x)
    println("Hello World")
end

自然科学を記述するにあたって欠かせない数学はどうでしょう？私がQiitaのアカウントを持ったきっかけは

$$
\left(\frac{d^2 q^{i}}{d s^2} + \Gamma^i_{jk} \frac{d q^j}{ds}\frac{d q^k}{ds}\right)\mathbf{e}_i = 0
$$

のように数式の入力がサポートされている事を知ったからです．これにより Qiita でも数学のトピックを紹介したり，数学的な概念を解説し対応するプログラムを同時に記述する事ができます．なんて素晴らしいことでしょう.

GitHub ではどうでしょうか？

OSS プロジェクトをホスティングするGitHubを用いるとソースコードを公開し，共有する事ができます．Gitの機能で文章の管理が容易になるだけでなく，プルリクエストの機能で共同で機能の追加修正をする事ができます．Issueトラッカーを使う事で機能追加のディスカッション，バグレポートを提出する事で元のプロジェクトを改善する事ができます．
最近の自分の活動は MathSeminar.jl という静的サイトジェネレータ Franklin.jl をベースに数学的文章を記述をメインにすることを前提とした自分用の執筆インフラを整備しています．ホームページのビルド時にプログラムを走らせその実行結果を可視化を含めた表示する仕組みや定義・命題・証明スタイル．必要に応じて 定理1.2.3 のように定理番号を__自動付与__させ，その命題をアンカーで参照することができます．Franklin.jl はマークダウンで記述する事ができます．Qiita ユーザーであれば慣れたシンタックスで書く事ができるので挑戦も容易です．
さて，数学に関する文章も__広い意味でソースコード__とみなせば OSS プロジェクトと同様の活動ができるはずです．執筆に用いた細かいTipもふくめオープンにしておけばそれをもとに別の素晴らしいトピックを作ってくれるかもしれませんし，自分が細かく書かなかった証明の穴を埋めるプルリクエストがやってくるかもしれません．
Issueで「ここわからないんだけれど・・・？みんなどう考えた？」のような議論ができるポテンシャルを秘めているはずです．そのはずなんです．

Issueで議論は可能か？

はい．ご覧の通り$で囲んで挟むスタイルを利用する事ができません．多くの人はこの時点で絶望した事でしょう．

ただし，GitHub のマークダウンで数式を表示しようという試みはあります．ここではその方法を紹介し，どの程度のことができるか試してみます．

やりましょう．

ひとまず，素材を持ってきます．TeXclip などで書きたい数式を $\LaTeX$ コマンドで記述します，

次に https://alexanderrodin.com/github-latex-markdown/ にアクセスします．

LaTeX formula のところにコマンドをペーストします．

下図のように　![\begin ... で始まる文字列をコピーします．右側にあるアイコンをクリックしてクリップボードにコピーすることが可能です．また Preview を使うことで表示を確認できます．

そしてコピーしたものをGitHubのIssueなどに貼り付けます．

![\begin{align*}   \left( \int_0^\infty \frac{\sin x}{\sqrt{x}} dx \right)^2 =   \sum_{k=0}^\infty \frac{(2k)!}{2^{2k}(k!)^2} \frac{1}{2k+1} =   \prod_{k=1}^\infty \frac{4k^2}{4k^2 - 1} = \frac{\pi}{2} \end{align*}](https://render.githubusercontent.com/render/math?math=%5Cbegin%7Balign*%7D%20%20%20%5Cleft(%20%5Cint_0%5E%5Cinfty%20%5Cfrac%7B%5Csin%20x%7D%7B%5Csqrt%7Bx%7D%7D%20dx%20%5Cright)%5E2%20%3D%20%20%20%5Csum_%7Bk%3D0%7D%5E%5Cinfty%20%5Cfrac%7B(2k)!%7D%7B2%5E%7B2k%7D(k!)%5E2%7D%20%5Cfrac%7B1%7D%7B2k%2B1%7D%20%3D%20%20%20%5Cprod_%7Bk%3D1%7D%5E%5Cinfty%20%5Cfrac%7B4k%5E2%7D%7B4k%5E2%20-%201%7D%20%3D%20%5Cfrac%7B%5Cpi%7D%7B2%7D%20%5Cend%7Balign*%7D)

できた！

Qiita でもできた

ちなみにGitHubに限らず，Qiitaにも貼り付けることができます．結果は下記の通り:

$\begin{align*} \left( \int_0^\infty \frac{\sin x}{\sqrt{x}} dx \right)^2 = \sum_{k=0}^\infty \frac{(2k)!}{2^{2k}(k!)^2} \frac{1}{2k+1} = \prod_{k=1}^\infty \frac{4k^2}{4k^2 - 1} = \frac{\pi}{2} \end{align*}$

もう少し見栄えを良くしたい

和や積分の範囲などの小さな文字の位置がちょっと気に入らないと感じる人もいるでしょう．この場合は先ほどの例の前に \displaystyle をつけておきます．

その結果がこちら

$\displaystyle \begin{align*} \left( \int_0^\infty \frac{\sin x}{\sqrt{x}} dx \right)^2 = \sum_{k=0}^\infty \frac{(2k)!}{2^{2k}(k!)^2} \frac{1}{2k+1} = \prod_{k=1}^\infty \frac{4k^2}{4k^2 - 1} = \frac{\pi}{2} \end{align*}$

これなら問題ないでしょう．もちろん，行列も記述可能ですし \displaystyle をつけておけば複数行に渡す式変形を記述することもできます．下記は確率変数の変換によって対応する密度関数がどう変化するかを書いた例です．

$\displaystyle \begin{align*} p(y) &= \int_{-\infty}^\infty \delta(y-f(x)) q(x) dx, \quad f(x)=ax\ &= \int_{-\infty}^\infty \delta(y-ax) q(x) dx \ &= \int_{-\infty}^\infty \frac{1}{a}\delta(y-\tilde{x}) q\left(\frac{\tilde{x}}{a}\right) d\tilde{x} \ &= \frac{1}{a}q\left(\frac{y}{a}\right) \end{align*}$

まとめ

技術的には可能ということがわかりました．上記の変換ツールを作成した a-rodin 氏の gist で動作原理を知ることができます: https://gist.github.com/a-rodin/fef3f543412d6e1ec5b6cf55bf197d7b#file-a-hack-for-showing-latex-formulas-in-github-markdown-md
変換ツールを経由する意味では clumsy ではありますが全くできないというわけではなさそうです．
実際のソフトを書く仕事でも「あー, これ言葉で説明せず数式一行で理解させられるのに〜」というところで悶々することもなくシュッと書いてポッと議論できればいいですね．

References:

You get articles that match your needs
You can efficiently read back useful information
You can use dark theme

What you can do with signing up