zackey推し

IT系のこと書くぞい

文章やRe:VIEW記法に自信がない自分が入れる、VSCodeプラグイン(拡張機能)やライブラリ #随時更新

f:id:kic-yuuki:20190321112359p:plain

最近、仕事でしかコードが書けておらず、プライベートでは文章しか書いていない orz

ただ、文章が苦手、かつRe:VIEW記法をしらなかった私は、事前に誤字脱字等の凡ミスを無くそうと思いました。

その際に見つけた「これはいい」と思ったVSCodeで文章を書くためのプラグイン拡張機能)やライブラリをメモしておきます。

この記事なに?

VSCodeユーザーかつ、文章を書きたいけど、

  • 誤字脱字がたぶんめっちゃある
  • わかりやすい文章を書く自信がない
  • 本を執筆するためRe:VIEW記法を使うけど自信ない

といった方(自分)に向けに送るメモです。

※他にも見つけたら随時更新・追記していきます。

お世話になっているプラグインとライブラリ

本(Re:VIEW)系

Re:VIEWプラグイン - VSCode

marketplace.visualstudio.com

これを導入することで、Re:VIEWの構文チェックをしてくれます!

Re:VIEWで脚注を記載する際、footnoteという書き方をします。イメージとしては次のような感じです。

@<fn>{OpenLayersで始める地図の操作}

//footnote[OpenLayersで始める地図の操作][https://speakerdeck.com/zucky_zakizaki/openlayersdeshi-merudi-tu-falsecao-zuo]

@<fn>{OpenLayersで始める地図の操作}の{}内の文字が、footnoteに定義されていない場合、VSCodeの問題欄でアラートしてくれたりします。超便利ですので、ぜひ一度使って見てください。

また、作者であるatsuhienoさんの次の記事には、プラグインの技術的な解説まで記載されています。もしよろしければ、合わせてご覧ください。そして、お世話になったらリポジトリにスターをつけてフィードバックしましょう!

atsushieno.hatenablog.com

md2review(ライブラリ - Gem)

Re:VIEW記法がわからなかった私は、最初はすべてMarkdownで記載していました。次のツールでMarkdownRe:VIEW記法に変換してくれるGemがあったからです!

github.com

使い方はREADMEに記載ありますが、すでにgemがインストール済みなら以下で変換できます。

# md2reviewのインストール
gem install md2review

# MarkdownからRe:VIEWへ変換
cd "変換対象のMarkdownがあるディレクトリ"
md2review your-document.md > your-document.re

文章系

テキスト校正くん(プラグイン - VSCode

marketplace.visualstudio.com

過去にじゃれみーさんの記事で紹介があり、その記事を見た記憶があったおかげで、見つけることができました。次の記事です。ほんと感謝です。

meuniere.hatenablog.jp

詳細は省きますが、このプラグインは、誤字脱字だけでなく見やすい文章を意識した指摘をしてくれます。(有能 of 有能)

例えば句読点が多いと、

一つの文で"、"を4つ以上使用しています(preset-japanese/max-ten)

のような指摘をしてくれます。おかげで編集者の方に大量の指摘をいただくことなく、寄稿を済ませることができました。。。

次のプラグインです。ぜひ文章に自信がない方は以下をインストールしてみてください!

WhiteSpace+(プラグイン - VSCode

marketplace.visualstudio.com

半角・全角スペース、タブを視覚的にわかりやすく表現してくれます。これによって、間隔の調整をどのスペース・タブで表現するかを統一しやすくなります。

また、Mac x VSCodeユーザーの方は、全角文字を未確定のままバックスペースを押下すると、制御文字が入り込んでしまうことがあるかと思います。別プラグインになりますが、次を導入&設定することで、その制御文字を保存時(自動フォーマット時)に削除してくれます。

marketplace.visualstudio.com

設定内容については、以下の記事を参考にしています。ぜひ合わせて一読いただければと思います!

kawaken.hateblo.jp

さいごに

最近、以下の合宿でしおりを作ったり、
Markdownで書きました)

note.mu

以下に寄稿しました。
技術書典6で頒布予定です!
Re:VIEWで書きました)

note.mu

そろそろプライベートでコード書くのを再開せねば。