Visual Studio Code で Markdown を書く方法

1. 目的

Visual Studio Code （以下、VS Code）で Markdown を書く方法をまとめました。

要件として、以下を満たす最小限の環境構築を目的としています。

• プレビューを表示しながら Markdown の編集ができる
• ショートカットを使用できる
• 文法ミスを教えてくれる

2. 環境

• macOS Ventura バージョン 13.6.5
• VS Code バージョン 1.74.2 (Universal)

3. 使用する拡張機能

VS Codeを起動し、 以下の 2 つの拡張機能をインストールします。

• Markdown All in One

  • VS Code で Markdown を書くための基本的な機能を提供します。
  • キーボードショートカットなどが使用可能になります。
  • リンク先に機能紹介があります。（英語）

• markdownlint

  • 文法的な間違いなどを指摘してくれます。

  

4. 準備

1. Markdown ファイル（.md）を作成する。
2. Markdown をファイル右クリックから「プレビューを開く」でプレビューが開く。
3. 開いたプレビューのタブをドラッグ＆ドロップで画面右に移動させる。

これでプレビューを確認しながら Markdown ファイルを編集する環境が整いました。

5. Markdown を書く

Markdown 記法については以下の記事が参考になります。

• ZennのMarkown記法一覧