Page symbol image
hyiromori's Blog
Web系エンジニア hyiromori のブログです

Markdownを好きなエディタで書きながらプレビューするnpmパッケージを公開してみた

僕はただ、Markdownを楽しく書きたかったんだ・・・!

はじめに

世の中にはMarkdownを書くための素晴らしいプロダクトがあります。(typoraとか)

しかしながら、私はどうしてもVimキーバインドで書きたいし、GitHubのREADMEとか書くことが多いのでGFM(GitHub Flavored Markdown)にしたいし、余計な機能がないシンプルなプレビューができれば良かったんです。

でも無いので、だったら自分で作ってみよう!と思ったので作ってみました。

(これなんかはイメージに近いんですけど、最終更新が2年以上前だし、やってみるチャンスだと思ったのも理由の一つです)

作ったもの

使い方

READMEの通りです。

※npmで公開しているので、nodeがあることが前提です。

$ npx @hyiromori/markdown-preview --port 34567 --file README.md

Root Directory : /current/dir
Default File   : /README.md
Preview URL    : http://localhost:34567/

デモも見ていただけるとイメージしやすいかもしれません。

DEMO

仕組み

普通のWebサーバーを立ててゴニョゴニョやっているだけです。 ちなみにカレントディレクトリをルートとして、静的ファイルの配信もできるので、パスがあっていれば画像などもちゃんと取得できます。

なのでngrokなどのサービスを使うと、グローバルにアクセスできるので、例えば遠隔MTGの議事録をMarkdownで書きつつ、みんなにリアルタイムに見てんもらう、なんてことにも使えるかもしれません。

やりたいこと