使い方

README.mdが存在していることを確認し、下記のコマンドを実行してください。

$ npm run gen

無事コンパイルが完了すると、docsディレクトリにhtmlファイルが出力されているはずです。そのままGitHub Pagesで公開するか、サーバーへデプロイして動作を確認してください。

編集モード

下記コマンドを実行すると、README.mdが監視状態になります。

$ npm run edit

監視状態中は、マークダウンファイルを編集するたびにコンパイルが実行されるようになります。出力されたhtmlファイルをブラウザで開き動作を確認してください。