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

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

Линтеры

Markdownlint

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

Как пользоваться: https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint

Markdown All in One

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

Как пользоваться: https://marketplace.visualstudio.com/items?itemName=yzhang.markdown-all-in-one 

LTeX – LanguageTool grammar/spell checking 

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

Как пользоваться: https://marketplace.visualstudio.com/items?itemName=valentjn.vscode-ltex 

Code Spell Checker + Russian - Code Spell Checker

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

Как пользоваться: https://marketplace.visualstudio.com/items?itemName=streetsidesoftware.code-spell-checker 

Proselint

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

Как пользоваться:  https://marketplace.visualstudio.com/items?itemName=PatrykPeszko.vscode-proselint

Textlint

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

Как пользоваться: https://marketplace.visualstudio.com/items?itemName=taichi.vscode-textlint 

Vale

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

Как пользоваться: https://marketplace.visualstudio.com/items?itemName=errata-ai.vale-server

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

Prettier - Code formatter 

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

Как пользоваться:  https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode 

OpenAPI (Swagger) Editor

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

Как пользоваться: https://marketplace.visualstudio.com/items?itemName=42Crunch.vscode-openapi#review-details

MdTableEditor

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

Как пользоваться: https://marketplace.visualstudio.com/items?itemName=clover.md-table-editor

GitHub Markdown Preview 

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

Как пользоваться: https://marketplace.visualstudio.com/items?itemName=bierner.github-markdown-preview

Markdown Checkboxes 

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

Как пользоваться: https://marketplace.visualstudio.com/items?itemName=bierner.markdown-checkbox

PlantUML

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

Как пользоваться:  https://marketplace.visualstudio.com/items?itemName=jebbs.plantuml 

Asciidoc

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

Как пользоваться: https://marketplace.visualstudio.com/items?itemName=asciidoctor.asciidoctor-vscode

reStructuredText Language 

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

Как пользоваться: https://marketplace.visualstudio.com/items?itemName=lextudio.restructuredtext

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

GitLens

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

Как пользоваться: https://marketplace.visualstudio.com/items?itemName=eamodio.gitlens

Git Graph

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

Как пользоваться: https://marketplace.visualstudio.com/items?itemName=mhutchie.git-graph

Git Project Manager

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

Как пользоваться: https://marketplace.visualstudio.com/items?itemName=felipecaputo.git-project-manager 

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

Markdown Emoji

✨