Объявление о расширении Docs Markdown для Visual Studio Code

Автор записи — Адам Кинней (Adam Kinney), старший инженер-разработчик в команде docs.microsoft.com.

Сегодня мы с радостью сообщаем о выпуске пакета для Docs Authoring Pack для Visual Studio Code, который еще больше упрощает участие в создании материалов для сайта docs.microsoft.com. Это первый выпуск пакета включает в себя три расширения:

  • Docs Markdown — предоставляет помощь по созданию Markdown, включая форматирование текста, вставку списков и таблиц, вставку ссылок на другие материалы, а также добавление изображений и других ресурсов. В отличие от других редакторов Markdown, решение Docs Markdown поддерживает пользовательские расширения Markdown для docs.microsoft.com, такие как оповещения и фрагменты кода.
  • DocFX — предоставляет ограниченный сайтом docs.microsoft.com предварительный просмотр, позволяющий узнать, как файл Markdown будет выглядеть при публикации.
  • markdownlint — популярный анализатор кода Markdown от Дэвида Ансона (David Anson), помогающий обеспечить соответствие Markdown рекомендациям.

Принцип работы

Сначала нужно установить его из Visual Studio Marketplace. Перейдя на страницу расширения, просто щелкните элемент Установить и следуйте инструкциям на экране:

Installation of the Docs Markdown Extension

После этого нужно перезагрузить Visual Studio Code, открыть файл Markdown и приступить к работе. Вы можете использовать сочетание клавиш Alt+M для доступа к палитре команд расширения Docs Markdown, что позволяет быстро форматировать текст (например, выделить его полужирным шрифтом или курсивом), вставить стандартные объекты Markdown, такие как нумерованный список или таблица, а также вставлять характерную для документации разметку для заметок, важных сведений и советов:

Extension command palette

Вы можете быстро вставить код из других файлов через DocFX-совместимое расширение Markdown и просмотреть страницу, с которой работаете, прямо в редакторе:

Preview the currently edited page

Участие в доработке

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

Для большинства видов участия вам потребуется принять условия лицензионного соглашения участника (CLA), подтвердив, что вы передаете нам права на использование своего вклада и уполномочены сделать это. Для получения подробных сведений посетите веб-страницу https://cla.microsoft.com.

При отправке запроса на включение внесенных изменений CLA-бот автоматически определит необходимость предоставления соглашения CLA и соответствующего оформления запроса на включение внесенных изменений (например, добавление метки, комментария). Просто следуйте инструкциям бота. Вам потребуется сделать это всего один раз для всех репозиториев корпорации Майкрософт, на которые распространяется CLA.

Отзывы

У вас есть идеи, как улучшить это расширение? Просто откройте новый вопрос.

И не забудьте подписаться на нашу учетную запись Twitter, чтобы следить за новостями.

Хотите улучшить условия труда для разработчиков? Присоединяйтесь к нашей команде!