Een nieuwe versie van Docs Authoring Pack voor VS Code

Dit bericht is geschreven door Megan Bradley, Senior Program Manager van het docs.microsoft.com team.

In april hebben we de eerste release aangekondigd van het Docs Authoring Pack voor VS Code, dat de Docs Markdown-extensie bevat, een extensie voor het bekijken van bewerkingen op basis van DocFX en markdownlint. Vandaag kondigen we met trots de tweede grote release van het Docs Authoring Pack aan, die de volgende nieuwe extensies bevat:

  • Code spellingcontrole. Op populaire vraag hebben we deze offline spellingcontrole gebundeld door Street Side Software, zodat inzenders al hun inhoud, inclusief codevoorbeelden, kunnen controleren zonder dat ze dat hoeven te doen via een onlineservice.
  • Docs-artikelsjablonen. Met deze extensie kunt u een Markdown-sjabloon toepassen op een nieuw bestand, waardoor het eenvoudiger wordt om inhoud en metagegevens op een consistente manier te maken.
  • Docs Preview. Een vervanging voor de DocFx-preview die is opgenomen in de eerste release van het Docs Authoring Pack. De nieuwe preview-extensie is veel robuuster en vertegenwoordigt de docs.microsoft.com CSS in hogere kwaliteit.

U kunt de extensies afzonderlijk installeren, via de bovenstaande koppelingen of in één bundel, via het Docs Authoring Pack.

Inleiding tot artikelsjablonen

Artikelsjablonen zijn geraamte Markdown-bestanden die standaardkoppen, bestandsmetagegevens, standaardtekst en andere basiselementen bevatten die voldoen aan de docs.microsoft.com richtlijnen, waardoor het bijdragen van nieuwe artikelen eenvoudiger wordt en u geen giswerk meer nodig hebt voor publicatievereisten.

Als u een nieuw bestand wilt maken op basis van een afsluitende sjabloon, drukt u op Alt+M en selecteert u Sjabloon:

sjabloon toepassen

Betere preview

De voormalige op DocFX gebaseerde preview-engine is vervangen door de gloednieuwe Docs Preview, die de volgende verbeteringen bevat:

  • Ondersteuning voor de CommonMark-compatibele Markdig-parser in plaats van DocFx-flavored Markdown (DFM).
  • Up-to-date docs.microsoft.com CSS, waardoor aangepaste Markdown-elementen met een hogere kwaliteit worden weergegeven.
  • Verbeterde betrouwbaarheid, waardoor previews sneller en zonder vertraging worden weergegeven.
  • Ondersteuning voor de steeds groeiende lijst met Docs-specifieke Markdown-extensies, zodra deze beschikbaar komen.

Bijdragen

De Docs Markdown-extensies zijn open source. Bijdragen zijn welkom.

Houd er rekening mee dat de meeste bijdragen vereisen dat u akkoord gaat met een licentieovereenkomst voor inzenders (CLA) die bevestigt dat u het recht hebt om ons het recht te geven om uw bijdrage te gebruiken in onze software en inhoud. 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 slechts één keer te doen in alle opslagplaatsen die eigendom zijn van Microsoft.

Feedback

Hebt u gedachten over hoe we de extensies 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!