Markdown, Extensions

Markdown, Extensions

https://giga.chat/link/gcsIbChixe

Для полноценной работы с документацией в VSCode, которая включает текст, код, таблицы и архитектурные схемы, базового функционала редактора достаточно, но расширения значительно ускорят процесс и добавят удобства.

Вот список проверенных расширений, разбитый по задачам:

1. Базовый набор (Must Have)

Эти расширения решают 95% повседневных задач.

• Markdown All in One (автор: Yu Zhang) Самое важное расширение. Оно автоматизирует рутину:
  • Автоматически создает оглавление (Table of Contents) по заголовкам.
  • Добавляет горячие клавиши: Ctrl+B для жирного, Ctrl+I для курсива.
  • Управляет нумерацией в списках и чекбоксами (- [ ] / - [x]).
  • Обновляет номера заголовков.
• Markdown Preview Enhanced (автор: Yiyi Wang) Если вам не нравится стандартный предпросмотр VSCode (который открывается по Ctrl+Shift+V), установите это расширение. Оно открывает красивую панель сбоку, которая обновляется в реальном времени, поддерживает сложные таблицы KaTeX (формулы) и лучше справляется с большими файлами.
• Paste Image (автор: Mushan) Незаменимое расширение для работы со скриншотами.
  • Как работает: Вы делаете скриншот (например, клавишей Print Screen), возвращаетесь в VSCode, нажимаете Ctrl+Alt+V. Расширение автоматически создает папку (например, images/), сохраняет туда картинку с текущей датой и вставляет в Markdown готовую ссылку: ![2026-10-09-12-00](images/2026-10-09-12-00.png).

2. Визуализация и диаграммы

Для ваших архитектурных схем.

• Markdown Preview Mermaid Support (автор: Matt Bierner) Обязательное расширение. Без него VSCode покажет ваш код Mermaid в предпросмотре как обычный текст. С этим расширением вы увидите красивые графические схемы (как в примере с Gateway).
• Mermaid Preview (автор: bk) Позволяет открывать .mmd файлы (файлы только с диаграммами) в отдельном окне предпросмотра, что удобно, если схема очень большая и сложная.

3. Написание и качество текста

• Code Spell Checker (автор: Street Side Software) Проверяет орфографию прямо в тексте Markdown. Пропускает код и команды, подчеркивая только обычный текст. Спасает от опечаток в названиях классов и документации.
• reStructuredText / Markdown Linter (автор: David Anson) Если вы захотите соблюдать строгий стиль (например, одинаковые заголовки, отсутствие лишних пробелов). Это тот самый «линтер», который иногда рисует волнистые линии. Устанавливать стоит, если вам нужна дисциплина текста; если раздражает — можно обойтись без него.

4. Профессиональная документация (на вырост)

Если вы решите превратить ваши .md файлы в полноценный сайт документации (как у Microsoft или Sber):

• DocFX (автор: Microsoft) Официальный инструмент от Microsoft. Позволяет одной кнопкой собрать из папки с Markdown-файлами красивый статический сайт со своим поиском, версионированием и темной темой.
• Docker (автор: Microsoft) Если вы будете использовать DocFX или MkDocs, Docker позволит запускать локальный сервер документации в изолированном контейнере, не засоряя систему.

Рекомендуемый минимум для старта:

1. Markdown All in One
2. Paste Image
3. Markdown Preview Mermaid Support
4. Code Spell Checker

Этого набора достаточно, чтобы писать архитектурные документы, мгновенно добавлять скриншоты, проверять ошибки и видеть схемы архитектуры прямо в редакторе.

------------------

Markdown All in One

Markdown Preview Enhanced

Paste Image

Markdown Preview Mermaid Support

Mermaid Preview

Code Spell Checker

DocFX

Docker

------

Markdown All in One

Paste Image

Markdown Preview Mermaid Support