Annonce de l’extension Docs Markdown pour Visual Studio Code

Ce billet a été écrit par Adam Kinney, ingénieur logiciel senior de l’équipe docs.microsoft.com.

Aujourd’hui, nous sommes ravis d’annoncer la publication du pack Docs Authoring pour Visual Studio Code, ce qui facilite la contribution à docs.microsoft.com. Cette première version du pack comprend trois extensions :

• Docs Markdown : fournit une assistance de création Markdown, notamment la mise en forme du texte, l’insertion de listes et de tables, l’insertion de liens vers d’autres contenus et l’ajout d’images et d’autres ressources. Contrairement à d’autres éditeurs Markdown, Docs Markdown prend en charge les extensions Markdown personnalisées pour docs.microsoft.com, telles que les alertes et les extraits de code.
• DocFX - fournit un aperçu Markdown limité docs.microsoft.com-spécifique à Markdown pour vous aider à voir à quoi ressemblera votre fichier Markdown lors de la publication.
• markdownlint - un linter Markdown populaire par David Anson pour vous assurer que votre Markdown suit les meilleures pratiques.

Fonctionnement

Tout d’abord, vous devez l’installer à partir de Visual Studio Marketplace. Une fois que vous accédez à la page d’extension , cliquez simplement sur Installer et suivez les messages à l’écran :

Une fois terminé, vous devez recharger Visual Studio Code, ouvrir un fichier Markdown et commencer à écrire ! Utilisez la combinaison de touches Alt+M pour accéder à la palette de commandes d’extension Docs Markdown, ce qui vous permet de mettre rapidement en forme le texte (par exemple, le rendre gras ou italique), d’insérer des entités Markdown standard, telles qu’une liste numérotée ou un tableau, ainsi que d’insérer un balisage spécifique à la documentation pour les notes, les informations importantes et les conseils :

Vous pouvez également insérer rapidement du code à partir d’autres fichiers via une extension Markdown compatible DocFX, et afficher un aperçu de la page sur laquelle vous travaillez directement dans l’éditeur :

Contribuer

L’extension est open source, et nous vous invitons à y apporter toutes les contributions !

La plupart des contributions vous obligent à accepter un contrat de licence contributeur (CLA) affirmant que vous avez le droit, et en fait, de nous accorder les droits d’utilisation de votre contribution. Pour plus d’informations, visitez https://cla.microsoft.com.

Lorsque vous envoyez une demande de tirage( pull request), un bot CLA détermine automatiquement si vous devez fournir un CLA et décorer correctement la demande de tirage (par exemple, étiquette, commentaire). Suivez simplement les instructions fournies par le bot. Vous n’aurez besoin de le faire qu’une seule fois sur tous les dépôts appartenant à Microsoft à l’aide de notre CLA.

Envoyer des commentaires

Avez-vous des idées sur la façon dont nous pouvons améliorer l’extension ? Tout simplement ouvrir un nouveau problème!

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

Vous rêvez de rendre le monde meilleur pour les développeurs ? Rejoignez notre équipe!