Annonce de l’extension Markdown Docs pour Visual Studio Code

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

Aujourd’hui, nous avons le plaisir d’annoncer la publication du pack Docs Authoring Pack pour Visual Studio Code, qui vous permet de contribuer à docs.microsoft.com avec une facilité inégalée. La première version du pack comprend trois extensions :

• Markdown Docs : fournit une aide à la création Markdown, dont la mise en forme de texte, l’insertion de listes et de tables, l’insertion de liens vers d’autres contenus ainsi que l’ajout d’images et d’autres ressources. Contrairement à d’autres éditeurs Markdown, Markdown Docs prend en charge les extensions Markdown personnalisées pour docs.microsoft.com, notamment les alertes et les extraits de code.
• DocFX : propose un aperçu Markdown spécifique à docs.microsoft.com limité afin de voir à quoi ressemblera votre fichier Markdown une fois publié.
• markdownlint : linter Markdown populaire créé par David Anson afin de garantir que votre Markdown suit les bonnes 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 l’installation terminée, 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 de l’extension Markdown Docs, ce qui vous permet de mettre rapidement en forme le texte (par exemple, gras ou italique), d’insérer des entités Markdown standard, comme une liste numérotée ou une table, ainsi que d’insérer un balisage spécifique à la documentation pour des notes, des informations importantes et des 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 :

Collaboration

L’extension est open source et toutes les contributions sont les bienvenues !

La plupart des contributions exigent que vous acceptiez les conditions d’un contrat de licence de contributeur (CLA, Contributor License Agreement) affirmant que vous avez le droit de nous accorder, et que vous nous accordez en fait, les droits d’utilisation de votre contribution. 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 devrez effectuer cette opération une seule fois sur tous les référentiels appartenant à Microsoft avec notre CLA.

Commentaires

Vous avez des idées sur la façon dont nous pouvons améliorer l’extension ? 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 !