Nouvelle version du pack de création de documentation pour VS Code

Ce billet a été écrit par Megan Bradley, Chef de programme senior au sein de l’équipe docs.microsoft.com.

En avril, nous avons annoncé la première version de Docs Authoring Pack pour VS Code, qui comprend l’extension Docs Markdown, une extension pour prévisualiser les modifications basée sur DocFX ainsi que markdownlint. Aujourd’hui, nous avons le plaisir d’annoncer la deuxième version majeure de Docs Authoring Pack, qui comprend les nouvelles extensions suivantes :

• Code Spell Checker. Pour répondre à la demande, nous avons ajouté ce vérificateur orthographique hors connexion de Street Side Software, pour que les contributeurs puissent vérifier l’orthographe de tout leur contenu, y compris les exemples de code, sans avoir à utiliser un service en ligne.
• Docs Article Templates. Cette extension vous permet d’appliquer un modèle Markdown à un nouveau fichier, ce qui permet de créer facilement du contenu et des métadonnées de manière cohérente.
• Docs Preview. Remplacement de l’aperçu DocFx compris dans la première version de Docs Authoring Pack. La nouvelle extension d’aperçu est bien plus robuste et représente le CSS docs.microsoft.com plus fidèlement.

Vous pouvez installer les extensions individuellement, en utilisant les liens ci-dessus, ou dans le même bundle en installant Docs Authoring Pack.

Présentation des modèles d’article

Les modèles d’article sont des fichiers Markdown structurels qui fournissent des éléments standard comme les titres, les métadonnées de fichier, le texte réutilisable et d’autres éléments de base qui suivent les directives de docs.microsoft.com. Ils vous permettent de créer facilement de nouveaux articles et évitent la conjecture liée aux exigences de publication !

Pour créer un fichier à partir d’un modèle existant, appuyez simplement sur Alt+M et sélectionnez Template :

Meilleur aperçu

L’ancien moteur d’aperçu basé sur DocFX a été remplacé par le tout nouveau Docs Preview, qui présente les améliorations suivantes :

• Prise en charge de l’analyseur Markdig compatible CommonMark, au lieu de DocFX-flavored Markdown (DFM).
• Mise à jour du CSS docs.microsoft.com, pour afficher les éléments Markdown personnalisés avec une meilleure fidélité.
• Amélioration de la fiabilité, pour afficher plus rapidement les aperçus, sans décalage.
• Prise en charge de la liste toujours plus longue des extensions Markdown propres à la documentation, à mesure qu’elles sont disponibles.

Collaboration

Les extensions Markdown pour la documentation sont open source !

N’oubliez pas que la plupart des contributions nécessitent que vous acceptiez les conditions d’un contrat de licence de contributeur (CLA) affirmant que vous avez le droit, et que vous l’appliquez, de nous accorder les droits d’utilisation de votre contribution dans nos logiciels et notre contenu. Pour plus d’informations, visitez https://cla.microsoft.com. Quand vous envoyez une demande de tirage (pull request), un bot CLA détermine automatiquement si vous devez fournir un contrat CLA et agrémenter la demande de tirage de façon appropriée (par exemple, avec une étiquette ou un commentaire). Suivez simplement les instructions fournies par le bot. Vous devez le faire seulement une fois pour tous les dépôts appartenant à Microsoft.

Commentaires

Vous avez des idées sur la façon dont nous pouvons améliorer les extensions ? Ouvrez un nouveau ticket !

Et n’oubliez pas de suivre notre compte Twitter pour les dernières mises à jour.

Vous rêvez d’un monde meilleur pour les développeurs ? Rejoignez notre équipe !