VSCode로 Markdown을 쓸 때의 확장 기능 엄선 3개+번외편

이 기사는 Visual Studio Code Advent Calendar 2020 - Qiita의 14 일째 기사입니다 🐈

저는 평소 Markdown을 쓸 때 VS Code를 사용하고 있습니다. 그런 VS Code Markdowner의 사람들에게 추천할 수 있는, 우선 이것은 최소한 넣어 두고 손해는 없다고 생각하는 것을 엄선해 보았습니다.

Prettier

Prettier - Code formatter - Visual Studio Marketplace

Markdown 의 문장을 포맷 해 줍니다.

사용법은 VS Code 의 설정에 "editor.defaultFormatter": "esbenp.prettier-vscode"를 설정해, Format Document ( Basic Editing in Visual Studio Code ) 하는 것 뿐입니다.
또 "editor.formatOnSave": true 를 설정하는 것으로 파일 보존시에 자동 포맷 해 줍니다.

"[markdown]": {
  "editor.defaultFormatter": "esbenp.prettier-vscode"
}

주의점은 three backticks (```) 로 둘러싸인 Code Blocks 를 파괴할 가능성이 있는 것과, 전각 문자와 반각 문자의 사이에 스페이스를 넣어 버리는 것입니다. 개인적으로 스페이스는 갖추어져 있으면 어느 쪽이라도 좋은 파입니다만, 다른 문서 교정등과 조합했을 때나, 스페이스를 비우지 않는 결정이 있는 경우는 이 확장 기능으로 Markdown 를 포맷 하지 않는 편이 좋습니다. VS Code 디폴트의 포매터도 전혀 사용할 수 없는 것은 아니기 때문에, 그쪽을 시험해 비교해 보는 것도 좋을까 생각합니다.

포맷 전과 포맷 후에는 이런 느낌. (일부로 많게 잘못 넣어 보았습니다)

markdownlint

markdownlint - Visual Studio Marketplace

Markdown의 문장을 린팅 해줍니다.

예를 들어 이 글의 문장이라면 이런 느낌으로 이상한 부분에 물결선이 휘어진 상태가 됩니다. 내용은 물결선에 마우스 커서를 맞추거나 VS Code 아래 메뉴의 Problems에서 확인할 수 있습니다. 이번은 3개소 경고되고 있는 상태군요.

Code Spell Checker

Code Spell Checker - Visual Studio Marketplace

철자 실수를 경고합니다.

실제 움직임은 이런 느낌입니다. 적당히 실수하기 쉬운 단어를 써서 수정해 보았습니다. 수정은 Ctrl+.(cmd+.)로 수정할 수 있습니다.



덧붙여서 이름 그대로 일본어는 경고하지 않습니다.

번외편

필요한 사람이 필요할 때 넣으면 좋다고 생각하는 번외편입니다.

Markdown PDF

Markdown PDF - Visual Studio Marketplace

Markdown을 PDF, HTML, PNG 파일 등으로 변환합니다. 아무래도 Markdown 을 열 수 없다 (or 열고 싶지 않다) 백성에게 보낼 때 사용하고 있습니다.
사용법은 간단하며 편집기에서 마우스 오른쪽 버튼을 클릭하고 Markdown PDF: Export를 선택하거나 명령 팔레트에서 동일한 항목을 찾아 선택하면 됩니다.

텍스트 교정군

텍스트 교정군 - Visual Studio Marketplace

일본어 문장을 확인해 줍니다.

Code Spell Checker는 철자만이지만, 여기는 일본어 문장의 일반적인 규칙까지 봐 줍니다. 사용법은 설치하기만 하면 됩니다.
아주 좋은 확장 기능이라고는 생각합니다만 거기까지 굳어진 문장을 쓰는 것이 없는 것과, 이것을 유효화하면 나의 문장은 거의 새빨갛게 되므로 필요할 때만 유효하게 하고 있습니다.

docs-markdown

docs-markdown - Visual Studio Marketplace

Markdown을 쓸 때의 굵은체나 코드, 테이블 등을 쓸 때를 보조해 줍니다.

Markdown을 작성할 수 없다면 어떻게 굵게 표시합니까? 이탤릭하게 하는 거야? 같은 일이 자주 있다고 생각합니다. 그것을 명령 팔레트에서 선택할 수 있게 되어 해소해 줍니다.
쓰는 것이 되어 있으면 명령 팔레트에서 찾는 편이 귀찮게 되어, 예를 들면 굵게 했을 경우에 선택 상태에서 * (asterisk) 키를 2회 누르는 편이 빠르네요. 그래서 Markdown 초보자를위한 것이라고 생각합니다.