Markdown
GFM
VSCode

MarkdownをGFMでプレビュー in VSCode

More than 1 year has passed since last update.

VSCodeでマークダウンを編集するとデフォルトでプレビューもできて便利ですよね。

しかし、GitHubのREADMEなんかを書いている時に悲しみが。

そう、VSCodeはGFM(GitHub Flavored Markdown)に対応していないのです。

普段は気にならないレベルですが、タスクリストなどを書いているときにモヤっとします。


そこで

GFMでプレビューする拡張機能を作りました。

vscode-gfm-preview

screenshot.png

基本的にはビルトインのMarkdownプレビューと同じように動くはずです。(ソースコピペしているので)


注意点

内部で GitHub API を使用していますので、オフラインでは使えません。

このAPIは、認証なし状態で60回/h、認証した状態で5,000回/h のリクエストを投げられます。(2016/11月現在)

拡張機能の設定で認証情報を入れられるので、頻繁にプレビューしたい方はユーザ名とパスワードを設定してください。

未認証で使いたい方や、リクエスト回数を節約したい方向けに、ファイル保存時のみプレビューを更新する設定を用意してありますので必要に応じて。

※未認証で使っていて回数が危なそうだからと言って途中で認証しても、残り回数はリセットされない様子です。その場合はリセットされるまでおとなしく待ちましょう。


参考

https://developer.github.com/v3/markdown/

https://developer.github.com/guides/getting-started/#authentication

https://developer.github.com/v3/#rate-limiting