VSCode を Markdownエディターとして活用する (macOS)

Visual Studio CodeMicrosoft製品ですが、Mac端末にインストールして利用することも可能です。ここではMacへインストールして利用する方法といくつかの便利な利用方法を記載しています。

1. 環境

  • macOS Big Sur version 11.3

2. VSCode をインストール

  1. 以下のURLを開いて「今すぐダウンロード」ボタンを押下する。

    https://azure.microsoft.com/ja-jp/products/visual-studio-code/ f:id:goroshimizu:20211123224431p:plain

  2. ダウンロードした「VSCode-darwin-universal.zip」を解凍すると「Visual Studio Code.app」ファイルができる。

    f:id:goroshimizu:20211123225054p:plain

  3. 上記で取得した「Visual Studio Code.app」をアプリケーションフォルダへドラックして、MacOS Launchpadで使用できるようにします。

    f:id:goroshimizu:20211123225246p:plain

  4. Mac の Launchpad から Visual Studio Code をダブルクリックして起動する。

    f:id:goroshimizu:20211123225332p:plain

  5. MacのDockに表示されているVS Codeのアイコンから、右クリック>オプション>Dockに保持 を選択して、VSCodeをDockに追加する。

3. Command Line から VSCode を起動する方法

  1. VS Codeを起動する。
  2. Command Paletteを起動する。( Cmd + Shift + p )
  3. 「shell commnad」と入力すると、Install 'code' command in PATH を見つけられるので、選択して return ボタンを押下する。

f:id:goroshimizu:20211123225423p:plain

  1. Macのターミナルを再起動すると「code」コマンドが利用できるようになる。ターミナルから「code -v」コマンドを実行するとバージョンが表示される。
  2. ターミナルの任意のディレクトリで「code .」コマンドを実行すると、VS Code が起動して、ターミナルで利用していた任意のディレクトリで、VS Codeのファイルの編集が始まる。

4. 設定ファイルの開き方(settings.json)

4.1. 方法1:設定画面から開く

  1. メニュー > Code > Preferences > Settings (ショートカット : commad + ,
  2. 右上のアイコンをクリック

    f:id:goroshimizu:20211123225456p:plain

4.2. 方法2:コマンドパレットから開く

  1. コマンドパレットを開く。(ショートカット:command + shift + p
  2. settings と入力する
  3. 設定を選択する
    1. 「Preferences: Open Settings (JSON)」
    2. 「Preferences: Open Workspace Settings (JSON)」

5. Markdownの改行を便利にする方法

Markdwonエディターで以下の入力をすると、

aaa
bbb
ccc

Markdownのプレビューでは改行されずに以下の表示となってしまう。

aaa bbb ccc

Markdownの正式な記述方法としては、行末に半角スペースを2個いれると改行する。ただしこの方法は手間になるため、以下の設定をすることでエディタで改行をすればMarkdown表記でも改行される。

  1. 設定を開く(command + ,)
  2. 検索窓から「markdown break」と入力する
  3. Markdown > Preview: Breaks」のチェックをONにする

    f:id:goroshimizu:20211123231937p:plain

エディターで以下の入力をすると、

aaa
bbb
ccc

Markdownのプレビューでは改行されずに以下の表示となった

aaa
bbb
ccc

6. 文章作成を効率化 (Markdown all in one)

Note:詳しくは Markdown all in one のサイト を確認する。

6.1. インストール

  1. 左メニューのExtensionsボタンを選択
  2. 検索窓に「markdown all in one」を入力
  3. Markdown All in One を選択してインストール

    f:id:goroshimizu:20211123225536p:plain

6.2. 章番号を自動採番する

  1. コマンドパレットを開く。command + shift + p
  2. markdown all in one」を入力する
  3. 「Add/Update section numbers」を選択する

    f:id:goroshimizu:20211123225558p:plain

  4. 章の名称の後ろに <!-- omit in toc --> があれば自動採番の対象外となる。

    記述例 # セクション <!-- omit in toc -->

6.3. 目次を作成する

  1. コマンドパレットを開く。command + shift + p
  2. markdown all in one」を入力する
  3. 「Create Table of Contents」を選択する

6.4. HTMLを生成する

  1. コマンドパレットを開く。command + shift + p
  2. markdown all in one」を入力する
  3. 「Print document to HTML (select a source folder)」を選択する
  4. 出力フォルダーを指定する
  5. 画像ファイルは手作業で出力フォルダへコピーする

6.5. 文字を太くする

  1. 文字を選択して、ショートカット(command + b)

6.6. URLリンクを付与する

  1. URLをコピーする。
  2. リンクを設定する対象文字を選択する。
  3. 「command + v」で、リンクが差し込まれる。

7. 文書作成を効率化 (Page Image)

Page Imageを利用すれば、Markdownエディターに簡単に画像を挿入することができます。スクリーンショットを撮ったら、Command + Opt + V で画像を貼り付けることが出来ます。

7.1. インストール

  1. 左メニューバーの Extensions を選択する
  2. 検索窓に「paste image」を入力する
  3. 複数のExtensionが抽出されますが、以下の画像のExtensionを選択して、インストールする。

    f:id:goroshimizu:20211123225622p:plain

  4. Macの場合は、VSCodeでmdファイルを開いて、画像を挿入する箇所にフォーカスを合わせて、「command + Option + v 」で画像を挿入できる。

7.2. Paste Image で挿入した画像サイズを変更可能にする

  1. 左メニューバーのExtensionボタンを選択する
  2. INSTALLEDから「Paste Image」を選択する
  3. 設定ボタンから「Extensions Settings」を選択する

    f:id:goroshimizu:20211123225649p:plain

  4. Insert Pattern のデフォルト設定は以下になります。

     ${imageSyntaxPrefix}${imageFilePath}${imageSyntaxSuffix}
    

    f:id:goroshimizu:20211123225714p:plain

  5. Insert Pattern の設定を以下に変更します。

     <img src='${imageFileName}' width='70%'>
    

    f:id:goroshimizu:20211123225736p:plain

8. 配色テーマ

参考 VS Codeで配色テーマをカスタマイズするには https://www.atmarkit.co.jp/ait/articles/1810/19/news032.html

8.1. テーマを選択する

  1. コマンドパレットを開く。command + shift + p
  2. 「theme」を入力する
  3. 「Preferences: Color Theme」を選択する
  4. 対象のテーマを選択する。

8.2. テーマをカスタマイズする

  1. 設定画面を開く。 Code > Preferences > Settings
  2. 検索窓に「workbench.colorCustomizations」を入力する。 f:id:goroshimizu:20211123225806p:plain

9. フォントサイズ

9.1. Editorのフォントサイズを変更する。

  1. Menu > Code > Preference > Settings を開く。
  2. User > Common Used > Editor: Font Size を変更する

9.2. Makdownのフォントサイズを変更する

  1. Menu > Code > Preference > Settings を開く。
  2. Extensions > Markdown > Preview: Font Size でフォントサイズを変更する。

10. ウィンドウ

10.1. Terminalウィンドウ

  • 「control + shift + @」でTeminalウィンドウの表示、非表示が切り替わる。
  • 「control + shift + ^」で新しいTerminalを開く。

11. Terminal

Mac標準のターミナルと、VS Codeのターミナルでは、環境変数が異なることがありました。 1. Command + , で Settings を開きます。 2. 検索窓で「terminal.integrated.inheritEnv」を入力します。 3. チェックボックスをOFFにします。

f:id:goroshimizu:20211123225830p:plain