Новый выпуск пакета разработки документов для VS Code

Эта запись была написана Меган Брэдли, старший менеджер по программе в команде docs.microsoft.com.

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

  • средство проверки орфографии. По популярному требованию мы упаковали этот автономный средство проверки орфографии Street Side Software, чтобы участники могли проверять все их содержимое, включая примеры кода, без необходимости делать это через веб-службу.
  • Шаблоны статей документации. Это расширение позволяет применять шаблон Markdown к новому файлу, что упрощает создание содержимого и метаданных согласованно.
  • предварительной версиидокументации. Замена предварительной версии DocFx, включенной в первый выпуск пакета разработки документов. Новое расширение предварительной версии гораздо надежнее и представляет docs.microsoft.com CSS в более высокой точности.

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

Общие сведения о шаблонах статей

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

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

применить шаблона

Улучшенная предварительная версия

Бывший модуль предварительной версии на основе DocFX был заменен новым предварительной версии документации, который включает следующие улучшения:

  • Поддержка средства синтаксического анализа Markdig с поддержкой CommonMarkвместо docFx-flavored Markdown (DFM).
  • Актуальные docs.microsoft.com CSS, отрисовка пользовательских элементов Markdown с более высокой точностью.
  • Улучшена надежность, что позволяет быстрее отображать предварительные версии и без задержек.
  • Поддержка постоянно растущего списка расширений Markdown для конкретных документов, так как они становятся доступными.

Способствовать

Расширения Docs Markdown являются открытым исходным кодом . Мы приветствуем вклад!

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

Отправка отзывов

Есть мысли о том, как мы можем сделать расширения лучше? Просто открыть новую проблему!

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

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