MarkdownをOMakeから

ken

プロジェクトのドキュメントにはテキストファイルを使っていたのですけれど，github を使っていると Markdown 書式もときどき使うことになります．

Markdown 書式は HTML よりもずっと単純な書式で HTML を生成するための Wiki 書式の一種です．

書くのは簡単なのですが，それでもちょこちょこミスはしてしまいます．ですので，実際に HTML を生成してブラウザで確認しないとうまく書けたか確証が持てません．github に同期すれば内容を確認することはできますけれども，そのたびにプロジェクトをコミットするのは面倒だし，ちょっと変です．

そこで手元で簡単に HTML に生成するための仕掛けを作りました．まずは HTML を生成するためのソフトウェアをインストールします．その名も markdown というパッケージがありますので，それをインストールすれば OK．以下のように実行すると readme.md という Markdown 書式のファイルを HTML を標準出力に表示します．

markdown readme.md

こうして出力される HTML をファイルに保存して，ブラウザで開けばいいのですが，それも少し面倒．そこで，どうせ OMake で管理しているプロジェクトに Markdown 書式を扱うための設定を追加しました．それが以下の Markdown.om．

markdown(name) =
    tmpdir = /tmp/$(PID)
    mkdir -p $(tmpdir)
    html = $(tmpdir)/$(removesuffix $(name)).html
    echo '<!DOCTYPE html>' >> $(html)
    echo '<meta charset="UTF-8" />' >> $(html)
    echo '<link href="file:///Users/wakita/lib/omake/markdown.css" rel="stylesheet">' >> $(html)
    markdown $(name) >> $(html)
    /usr/bin/open $(html)

OMakeroot に Markdown.om を読み込んだ上で，OMakefile のなかで以下のような規則を書けば，omake docで，ドキュメントをブラウザで確認できるようになります．

doc:
    markdown(note.md)