28 расширений VS Code для разработки документации⁠⁠

Собственно, это плагины для VS Code, без которых техническим писателям и разработчикам документации жить можно, но сложно. В подборке — линтеры, форматирование, работа с git, проектирование API, подготовка схем и милота для удобной разработки.

Здесь мы вам даем еще больше полезностей: полезные сервисы и фишки, мануалы и статьи готовые решения на CSS, Javascript и не только

Линтеры

Markdownlint

Самый популярный линтер для разметки Markdown. Подсвечивает распространенные проблемы.

Как пользоваться

Markdown All in One

Поддержка разметки Markdown в Visual Studio Code. Форматирование таблиц, оглавление, рендеринг в HTML.

Как пользоваться

LTeX – LanguageTool grammar/spell checking

Проверка орфографии и стилистики английского и русского языка по правилам LanguageTool.

Как пользоваться

Code Spell Checker + Russian - Code Spell Checker

Проверка опечаток в английском и русском тексте и коде. Находит опечатки даже в названиях переменных в коде. Можно использовать расширение совместно с LTeX.

Как пользоваться

Proselint

Расширение линтера англоязычной прозы Proselint. Создатели сервиса вдохновлялись Чаком Палаником, Марком Твеном, Джоржем Оруэллом и другими писателями.

Как пользоваться

Textlint

Расширение open source сервиса Textlint, написанного на JS.

Как пользоваться

Vale

Семантический линтер с возможностью задавать свои правила, настройки и конфигурации проверок на то, что вам нужно.

Как пользоваться

Форматирование и форматы

Prettier - Code formatter

Расширение помогает так хорошо отформатировать текст в Markdown, что на него не ругается линтер.

Как пользоваться

OpenAPI (Swagger) Editor

Расширение для редактирования, форматирования спецификации OpenAPI (Swagger) в YAML или JSON.

Как пользоваться

MdTableEditor

Расширение исключительно для таблиц Markdown. Подсвечивает строки, столбцы и добавляет кнопки для операций с таблицами на командную панель.

Как пользоваться

GitHub Markdown Preview

Предварительный просмотр файлов Markdown в формате и стилистике GitHub.

Как пользоваться

Markdown Checkboxes

Расширение добавляет поддержку флажков и списков задач с предварительным просмотром.

Как пользоваться

PlantUML

Расширенная поддержка PlantUML.

Как пользоваться

Asciidoc

Расширение поддерживает предварительный просмотр в реальном времени, подсветку синтаксиса и cниппеты для формата AsciiDoc.

Как пользоваться

reStructuredText Language

Расширение для полноценной работы с языком разметки reStructuredText.

Как пользоваться

Работа с системой контроля версий

GitLens

GitLens поддерживает операции с git и визуализирует всю историю кода — когда была изменена строка или блок кода, как код менялся. Можно проследить эволюцию кодовой базы.

Как пользоваться

Git Graph

Визуализирует весь таймлайн с коммитами и ветками. Позволяет работать с git через интерфейс.

Как пользоваться

Git Project Manager

Расширение позволяет открывать новое окно с репозиторием git из окна VS Code и быстро переключаться между репозиториями.

Как пользоваться

Удобство и милота

Markdown Emoji

✨

🚀(здесь ссылка)

HTTP/s and relative link checker

Поиск битых ссылок в Markdown-тексте.

Как пользоваться

Settings Sync

Синхронизирует настройки и конфигурации VSCode. Для синхронизации используется Github Gist.

Как пользоваться

PDF

Расширение конвертирует файлы Markdown в файлы PDF, HTML, PNG, JPEG.

Как пользоваться

Markdown Paste

Расширение делает скриншоты и сразу же ссылки на них в файлах Markdown.

Как пользоваться

Word Count

Подсчет символов в документе.

Как пользоваться

Auto Close Tag

Добавляет закрывающий тег.

Как пользоваться

Rainbow bracket

Каждой паре всех видов скобок расширение дает свой цвет радуги. Красным цветом подсвечены незакрытые скобки.

Как пользоваться

Live Server

Локальный сервер разработки с функцией перезагрузки в реальном времени для статических и динамических страниц. Рендеринг по кнопке.

Как пользоваться

Material Theme Icons

Иконки к файлам и папкам.

Как пользоваться