Aankondiging van de Docs Markdown-extensie voor Visual Studio Code

Dit bericht is geschreven door Adam Kinney, Senior Software Engineer van het docs.microsoft.com-team.

Vandaag kondigen we met trots de release van het Docs-ontwerppakket voor Visual Studio Code aan, waarmee gebruikers nog gemakkelijker bijdragen kunnen leveren op docs.microsoft.com. Deze eerste release van het pakket omvat drie extensies:

  • Docs Markdown: Biedt hulp bij het schrijven van Markdown, inclusief het formatteren van tekst, het invoegen van lijsten en tabellen, het invoegen van koppelingen naar andere inhoud en het toevoegen van afbeeldingen en andere assets. In tegenstelling tot andere Markdown-editors biedt Docs Markdown ondersteuning voor aangepaste Markdown-extensies voor docs.microsoft.com, zoals waarschuwingen en codefragmenten.
  • DocFX: biedt een beperkte, specifieke Markdown-preview voor docs.microsoft.com, zodat u kunt zien hoe uw Markdown-bestand eruit ziet wanneer u dit publiceert.
  • markdownlint: een populaire Markdown-linter van David Anson die u kunt gebruiken om te garanderen dat uw Markdown de best practices volgt.

Hoe werkt het?

U moet de linter eerst installeren vanuit de Visual Studio Marketplace. Navigeer naar de pagina met extensies, klik op Installeren en volg de berichten op het scherm:

Installation of the Docs Markdown Extension

Zodra u klaar bent, moet u Visual Studio Code opnieuw laden. Vervolgens kunt u een Markdown-bestand openen en beginnen met schrijven. Gebruik de toetscombinatie Alt+M voor toegang tot het opdrachtenpalet van de Docs Markdown-extensie. Hiermee kunt u snel tekst opmaken (bijv. vetgedrukt of cursief), standaard Markdown-entiteiten zoals een genummerde lijst of een tabel invoegen en Docs-specifieke markeringen voor notities, belangrijke informatie en tips invoegen:

Extension command palette

U kunt ook snel code uit andere bestanden invoegen via een DocFX-compatibele Markdown-extensie en rechtstreeks in de editor een preview bekijken van de pagina waar u aan werkt:

Preview the currently edited page

Bijdragen

De extensie is open source. We stellen bijdragen zeer op prijs.

Voor de meeste bijdragen geldt dat u akkoord moet gaan met een licentieovereenkomst voor bijdragers (CLA), waarin u bevestigt dat u het recht hebt om ons de rechten voor het gebruik van uw bijdrage te verlenen en dat u dat hierbij ook daadwerkelijk doet. Ga naar https://cla.microsoft.com voor meer informatie.

Wanneer u een pull-aanvraag indient, wordt met een CLA-bot automatisch bepaald of u een CLA moet verschaffen en wordt de pull-aanvraag dienovereenkomstig opgemaakt (bijvoorbeeld met een label of commentaar). Volg gewoon de instructies van de bot. U hoeft dit maar eenmalig te doen met onze CLA, voor alle opslagplaatsen in eigendom van Microsoft.

Feedback

Hebt u suggesties hoe we de extensie kunnen verbeteren? Open een nieuwe kwestie!

En vergeet niet ons Twitter-account te volgen voor de nieuwste updates.

Is het uw droom om de wereld te verbeteren voor ontwikkelaars? Kom bij ons team!