Новый выпуск пакета Docs Authoring Pack для VS Code

  • Статья

Автор записи — Мэган Брэдли (Megan Bradley), старший программный руководитель команды docs.microsoft.com.

В апреле объявлен первый выпуск Docs Authoring Pack для VS Code, в который входят расширение Docs Markdown для предварительного просмотра правок на основе DocFX, а также markdownlint. Сегодня с радостью объявляем о втором основном выпуске Docs Authoring Pack, который включает в себя следующие новые расширения:

  • Code Spell Checker — согласно распространенным просьбам в состав добавлено автономное средство проверки орфографии от Street Side Software, позволяющее участникам проверять все содержимое, в том числе примеры кода, без необходимости привлекать для этого веб-службу;
  • Docs Article Templates — это расширение позволяет применять шаблон Markdown к новому файлу, упрощая создание содержимого и метаданных в согласованном виде;
  • Docs Preview — замена средству предварительного просмотра DocFx из первого выпуска Docs Authoring Pack. Новое расширение намного надежнее и представляет CSS docs.microsoft.com более точно.

Вы можете устанавливать расширения по отдельности, используя ссылки выше, или совокупно — в виде Docs Authoring Pack.

Знакомство с шаблонами статей

Шаблоны статей — это основы файлов Markdown со стандартными заголовками, метаданными файла, стандартным текстом и другими основными элементами, оформленными согласно рекомендациям docs.microsoft.com. Они упрощают разработку новых статей и устраняют необходимость раздумывать над требованиями к публикации.

Чтобы создать файл на основе существующего шаблона, просто нажмите ALT+M и выберите шаблон:

Применение шаблона

Улучшенный предварительный просмотр

Прежний механизм предварительного просмотра на основе DocFX заменен на Docs Preview, расширение, предусматривающее следующие улучшения:

  • средство синтаксического анализа CommonMark, совместимое с Markdig, вместо Markdown для DocFx;
  • актуальные возможности CSS для docs.microsoft.com, настраиваемые элементы Markdown визуализируются с более высокой точностью;
  • увеличена надежность, усовершенствовано преобразование для предварительного просмотра, устранены задержки;
  • список расширений Markdown для Документации постоянно увеличивается по мере их появления.

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

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

Учитывайте, что для большинства видов разработки вам потребуется принять условия лицензионного соглашения участника (Contributor License Agreement, CLA), чтобы подтвердить, что вы передаете корпорации Майкрософт права на использование в программном обеспечении и содержимом. Для получения подробных сведений посетите веб-страницу https://cla.microsoft.com. При отправке запроса на включение внесенных изменений CLA-бот автоматически определит необходимость предоставления соглашения CLA и соответствующего оформления запроса на включение внесенных изменений (например, добавление метки, комментария). Просто следуйте инструкциям бота. Это потребуется сделать всего единожды для всех репозиториев Майкрософт.

Отзывы

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

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

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