はじめに

ShikiMLとは

ShikiMLとはテキストアートで記述した数式をTeX記法に変換するプリプロセッサです。
ShikiMLはブラウザおよびnode.jsで動作します。

インストール方法

npmを使用してインストールします。

$ npm install -g shikiml

ブラウザからの使用方法

scaffold

HTMLファイルを生成したいフォルダに移動し、以下のコマンドを実行します。

$ shikiml scaffold filename.html

いくつかの質問に答えることでShikiMLのjsファイルと骨組みとなるHTMLファイルが生成されます。

記述

ShikiMLはdivタグまたはscriptタグに記述します。

divタグを使用するときはクラス名にshikiと記述します。 クラス名はオプションで変更できます。

<div class="shiki">
S = k  ln W
     B
</div>

scriptタグを使用するときはtypeをx-shikiにします。 type名はオプションで変更できます。

<script type="text/x-shiki">
S = k  ln W
     B
</script>

コマンドラインからの使用方法

単純なプリプロセッサ

ShikiMLを単純なプリプロセッサとして使用するときには以下のように入力します。

$ shikiml filename.shiki[.extension]

ファイル中の<shiki>から</shiki>まで囲った部分がTeX記法になって変換されます。

tex2imgとの連携

tex2imgがインストールされていれば、 tex2imgと連携してShikiML記法の部分を画像にして表示することができます。

以下のように使用します。

$ shikiml tex2img filename.shiki[.extension]

ここで、拡張子は以下のものが使用できます。

拡張子
拡張子 記述方法
md ```shikiから```まで
adoc [shiki]で記述された引用
html クラス名にshikiのあるdiv,preタグまたはtypeがtext/x-shikiのscriptタグ

画像ファイルはデフォルトではimgです。変更するには–image-dirオプションで変更します。

拡張子がhtmlのとき、–data-uriオプションを使用することで画像を data URIで埋め込むことができます。

標準入力からの読み込み

以下のようにすれば標準入力から読み込み、結果を標準出力に表示できます。

$ shikiml -