En ny version av Docs-redigeringspaketet för VS Code
Det här inlägget skrevs av Megan Bradley, Senior Program Manager i docs.microsoft.com team.
I april tillkännagav vi den första versionen av Docs Authoring Pack för VS Code, som innehåller Docs Markdown-tillägget, ett tillägg för förhandsgranskningsredigeringar baserade på DocFX samt markdownlint. Idag är vi glada att kunna presentera den andra större versionen av Docs Authoring Pack, som innehåller följande nya tillägg:
- Stavningskontroll för kod. Efter populär efterfrågan har vi paketerat denna offline-stavningskontroll av Street Side Software, så att deltagare kan stavningskontrollera allt sitt innehåll, inklusive kodexempel, utan att behöva göra det via en onlinetjänst.
- Dokumentartikelmallar. Med det här tillägget kan du tillämpa en Markdown-mall på en ny fil, vilket gör det enklare att skapa innehåll och metadata på ett konsekvent sätt.
- Dokumentförhandsgranskning. En ersättning för DocFx-förhandsversionen som ingår i den första versionen av Docs Authoring Pack. Det nya förhandsversionstillägget är mycket mer robust och representerar docs.microsoft.com CSS med högre återgivning.
Du kan installera tilläggen individuellt, via länkarna ovan eller i ett enda paket via Docs Authoring Pack.
Artikelmallar är skelett Markdown-filer som tillhandahåller standardrubriker, filmetadata, exempeltext och andra grundläggande element som följer docs.microsoft.com riktlinjer, vilket gör det enklare att bidra med nya artiklar och eliminera gissningar från publiceringskrav!
Om du vill skapa en ny fil baserat på en mall som avslutas trycker du bara på Alt+M och väljer Mall:
Den tidigare DocFX-baserade förhandsgranskningsmotorn ersattes med den helt nya Docs Preview som innehåller följande förbättringar:
- Stöd för Den CommonMark-kompatibla Markdig-parsern i stället för DocFx-flavored Markdown (DFM).
- Uppdaterad docs.microsoft.com CSS, vilket återger anpassade Markdown-element med högre återgivning.
- Förbättrad tillförlitlighet, vilket gör att förhandsversioner återges snabbare och utan fördröjningar.
- Stöd för den ständigt växande listan över Docs-specifika Markdown-tillägg när de blir tillgängliga.
Docs Markdown-tilläggen är öppen källkod – vi välkomnar bidrag!
Tänk på att de flesta bidrag kräver att du godkänner ett licensavtal för deltagare (CLA) som bekräftar att du har rätt att, och faktiskt gör det, ge oss rätt att använda ditt bidrag i vår programvara och innehåll. 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 detta en gång på alla Microsoft-ägda lagringsplatser.
Har du några tankar om hur vi kan göra förlängningarna 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!