Nuova versione di Docs Authoring Pack per VS Code

  • Articolo

Questo post è stato scritto da Megan Bradley, Senior Program Manager nel team docs.microsoft.com.

Ad aprile abbiamo annunciato la prima versione del Docs Authoring Pack per VS Code, che include l'estensione Docs Markdown, un'estensione per l'anteprima delle modifiche basate su DocFX, nonché markdownlint. Oggi siamo lieti di annunciare la seconda versione principale del Docs Authoring Pack, che include le nuove estensioni seguenti:

  • Controllo ortografico del codice. Per popolare domanda, abbiamo raggruppato questo controllo ortografico offline da Street Side Software, in modo che i collaboratori possano controllare tutto il loro contenuto, inclusi esempi di codice, senza dover eseguire questa operazione tramite un servizio online.
  • Modelli di articolo di Docs. Questa estensione consente di applicare un modello Markdown a un nuovo file, semplificando la creazione di contenuto e metadati in modo coerente.
  • Docs Preview. Sostituzione dell'anteprima di DocFx inclusa nella prima versione del Docs Authoring Pack. La nuova estensione di anteprima è molto più affidabile e rappresenta la docs.microsoft.com CSS in maggiore fedeltà.

È possibile installare le estensioni singolarmente, tramite i collegamenti precedenti o in un singolo bundle, tramite docs Authoring Pack.

Introduzione ai modelli di articolo

I modelli di articolo sono file Markdown scheletro che forniscono intestazioni standard, metadati di file, testo boilerplate e altri elementi di base che seguono le linee guida di docs.microsoft.com, rendendo più semplice il contributo di nuovi articoli ed eliminare i tentativi di indovinazione dai requisiti di pubblicazione!

Per creare un nuovo file in base a un modello di uscita, premere ALT+M e selezionare Modello:

applicare il modello

Anteprima migliore

Il precedente motore di anteprima basato su DocFX è stato sostituito con il nuovo docs Preview, che offre i miglioramenti seguenti:

  • Supporto per il parser Markdig conforme a CommonMark anziché DocFx-flavored Markdown (DFM).
  • Aggiornato docs.microsoft.com CSS, rendering di elementi Markdown personalizzati con una maggiore fedeltà.
  • Miglioramento dell'affidabilità, rendendo più veloci le anteprime e senza ritardi.
  • Supporto per l'elenco in continua crescita delle estensioni Markdown specifiche di Docs, in quanto diventano disponibili.

Collabora

Le estensioni Docs Markdown sono open source: sono disponibili contributi di benvenuto!

Tenere presente che la maggior parte dei contributi richiede l'accettazione di un Contratto di licenza collaboratore (CLA) che ha il diritto di, e in realtà, concederci i diritti per l'uso del contributo nel nostro software e contenuto. Per informazioni dettagliate, vedere https://cla.microsoft.com. Quando si invia una richiesta pull, un bot CLA determina automaticamente se è necessario specificare un contratto CLA e completare la richiesta pull in modo appropriato (ad esempio con un'etichetta e un commento). Seguire le istruzioni specificate dal bot. Questa operazione deve essere eseguita una sola volta in tutti i repository di proprietà di Microsoft.

Commenti e suggerimenti

Avete pensato a come possiamo rendere migliori le estensioni? è sufficiente aprire un nuovo problema.

Per restare al corrente con gli ultimi aggiornamenti, seguire l'account Twitter.

Si vuole contribuire a semplificare le attività per gli sviluppatori? È possibile entrare a far parte del nostro team!