😸

VSCodeでMarkdown環境を整える(Mac)

2022/09/15に公開

がく@ちゅらデータエンジニアです。

あいさつ

2022年9月よりちゅらデータにJoinしました。ちょっと更新が滞ってたんですが、これから色々やってることなどを書いていこうかなと思ってます。今後ともご贔屓に〜

はじめに

新しいMBP(2021年版M1,32GB!!)が来たので、業務しやすくするために色々セッティングしてます。
その中で、議事録とかメモとかをMarkdown形式で取りたいなと思いました。
開発でVSCodeを使っていたので、メモ取りなどにも使おう!とおもい、そのセッティングについてまとめてみようと思います。

VSCodeのインストール

Homebrew経由でのインストール

Macの場合なら、アプリのインストールなどの管理は  homebrew を使うととても楽です。

% brew install visual-studio-code --cask

公式サイトからもインストールできるとは思いますが、そこは割愛

私の環境

  • Macbook Pro M1 Pro 32GB OS:macOS Monterey
  • VSCode ver. 1.71.1

実現したい機能

Markdownで気持ちよく議事録やメモを行いたい。

  • タグの自動補完とかしたい
    • 拡張機能
  • プレビュー
    • 標準機能(下記でトグルします)
      • コマンドパレットより「Markdown: Open Preview to the Side」
      • Command  +  K → V
  • エクスポート
    • PDFとかで出力したい。拡張機能
  • 正しい文法でMarkdownを記述したい(Linter)
    • 拡張機能を活用

セットアップ

下記の拡張機能をマーケットプレイスから導入する

  • Markdown All in One
    • キーボードショートカット、オートコンプリート、目次作成、箇条書きの編集支援など
  • Markdown PDF
    • PDFでエクスポート、HTMLやPNGも可能
  • markdownlint
    • 文法やスタイルを性的に解析し通知してくれる
  • Text Tables
    • テーブルをつくったりする

使ってみた

https://zenn.dev/ctrlkeykoyubi/articles/vscode-markdown-all-in-one
Markdown All in Oneの使い勝手

ショートカット

Ctrl+B : 太字
Ctrl+i : 斜め文字

目次を生成

コマンドパレットを出して、create table of contents
ただ、あとから追加した見出しは自動で追記されるってことはないかもしれない。

Update table of contents を選ぶと更新できるっぽい

リスト自動補完

リストを一度作ると勝手にリストとして「-」を保管してくれたり、インデントを保存してくれたり
一番良き

Table関連

コマンドパレットを開いて Text Tables ってやると

  • Create Table
  • Enter table mode
    • ENTERを押すと次の行に、テーブルが追加される

PDFへExport

コマンドパレットを開いて Markdown PDF: Export(pdf)

同じディレクトリに、 hoge.pdf ってのができる

参考

https://qiita.com/DaikiSuyama/items/f51a407584084c04b5cd
https://qiita.com/84zume/items/1e6c720caba9898f5af2
https://zenn.dev/ctrlkeykoyubi/articles/vscode-markdown-all-in-one

Discussion