ITエンジニア/デザイナ向けにオープンソースを毎日紹介

Markdownで書いてHTMLでプレビューするためのツールは多種多様に存在します。Markdownエディタを使えばリアルタイムにコンテンツが更新されますし、HTML変換ソフトウェアを使う手もあるでしょう。

自分で書いたMarkdownファイルがGitHubなどにアップロードした時にどう見えるか簡単に確認したい場合はoctodownを使ってみてはいかがでしょう。

octodownの使い方

インストールはRubygemsを使って簡単にできます。

gem install octodown

コマンドはoctodownです。使い方としては引数にMarkdownファイルを指定するだけです。

octodown README.md

そうするとWebブラウザが立ち上がってGitHubのスタイルシートを適用した表示がされます。
そうするとWebブラウザが立ち上がってGitHubのスタイルシートを適用した表示がされます。

--style atomとするとAtomのMarkdownプレビューを適用した表示になります。

こちらがatomオプションをつけた場合。若干表示が異なります。
こちらがatomオプションをつけた場合。若干表示が異なります。

octodownはテンポラリファイルを生成してブラウザで表示します。HTMLファイルを同じディレクトリに生成したりしないので余計なファイルが増えるのを防げます。コマンドで使えるのは手軽です。

octodownはRuby製、MIT Licenseのオープンソース・ソフトウェアです。

ianks/octodown

 

MOONGIFTの関連記事

コメント

  • DevRel
  • Com2