Vi presenterar Docs Markdown-tillägget för Visual Studio Code

Det här inlägget skrevs av Adam Kinney, Senior Software Engineer i docs.microsoft.com-teamet.

Idag är vi glada att kunna presentera Docs-redigeringspaketet för Visual Studio Code, vilket gör det enklare än någonsin att bidra till docs.microsoft.com. Den första versionen av paketet innehåller tre tillägg:

• Docs Markdown – ger redigeringshjälp för Markdown inklusive att formatera text, infoga listor och tabeller, infoga länkar till annat innehåll och lägga till bilder och andra tillgångar. Till skillnad från andra Markdown-redigerare stöder Docs Markdown anpassade Markdown-tillägg för docs.microsoft.com, som aviseringar och kodavsnitt.
• DocFX – erbjuder en begränsad docs.microsoft.com-specifik Markdown-förhandsgranskning för att hjälpa dig se hur din Markdown-fil kommer att se ut när den publiceras.
• markdownlint – en populär Markdown-linter av David Anson för att säkerställa att din Markdown-följer praxis.

Hur det fungerar

Först måste du installera den från Visual Studio Marketplace. När du navigerat till tilläggssidan, klickar du på Installera och följer meddelandena på skärmen:

När du är klar, bör du ladda om Visual Studio Code, öppna en Markdown-fil och börja koda! Använd tangentkombinationen Alt+M för att komma åt Docs Markdown-tilläggets kommandopalett så att du snabbt kan formatera text (t.ex. göra den fet eller kursiv), infoga standard Markdown-entiteter, som en numrerad lista eller en tabell, samt infoga docs-specifik markup för anteckningar, viktig information och tips:

Du kan också snabbt infoga kod från andra filer via ett DocFX-kompatibelt Markdown-tillägg och förhandsgranska sidan som du arbetar med direkt i redigeraren:

Bidra

Tillägget har öppen källkod och vi välkomnar alla bidrag till det!

De flesta bidrag kräver att du samtycker till ett licensavtal för bidragare (CLA) som bekräftar att du har behörighet att och faktiskt ger oss rätt att använda ditt bidrag. Mer information finns på https://cla.microsoft.com.

När du skickar en pull-förfrågan avgör en CLA-robot automatiskt om du måste tillhandahålla ett licensavtal för bidrag med lämplig PR (t.ex. etikett eller kommentar). Följ bara robotens anvisningar. Du behöver bara göra det här en gång för alla Microsoft-ägda centrallager med vår CLA.

Feedback

Har du några idéer om hur vi kan göra tillägget bättre? Det är bara att öppna ett nytt ärende!

Glöm inte heller att följa vårt Twitter-konto för de senaste uppdateringarna.

Drömmer du om att göra världen bättre för utvecklare? Gå med i vårt team!