Condividi tramite

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 di Docs Authoring Pack per VS Code, che include l'estensione Markdown Docs, un'estensione per visualizzare in anteprima le 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 richiesta popolare, abbiamo in bundle questo correttore ortografico offline da Street Side Software, in modo che i collaboratori possano controllare tutto il contenuto, inclusi gli esempi di codice, senza dover farlo tramite un servizio online.
  • Docs Modelli di articolo. 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 il 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 uno scheletro di file Markdown che forniscono intestazioni standard, metadati di file, testo boilerplate e altri elementi di base che seguono le linee guida docs.microsoft.com, rendendo i nuovi articoli più semplici ed eliminando i tentativi di pubblicazione dai requisiti di pubblicazione.

Per creare un nuovo file basato su un modello di uscita, premere semplicemente ALT+M e selezionare Modello:

applicare modello

Anteprima migliore

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

  • Supporto per il parser Markdig conforme a CommonMark, invece di DocFx-flavored Markdown (DFM).
  • Up-to-date docs.microsoft.com CSS, rendering di elementi Markdown personalizzati con maggiore fedeltà.
  • Maggiore affidabilità, rendendo le anteprime più veloci e senza ritardi.
  • Supporto per l'elenco in continua crescita delle estensioni Markdown specifiche di Docs, man mano che diventano disponibili.

Contribuire

Le estensioni Docs Markdown sono open source. I contributi sono benvenuti.

Tenere presente che la maggior parte dei contributi richiede che l'utente accetti un Contratto di licenza collaboratore (CLA) affermando che si ha il diritto di concedere a Microsoft i diritti per l'uso del contributo nel software e nel contenuto. Per informazioni dettagliate, visitare https://cla.microsoft.com. Quando si invia una richiesta pull, un bot CLA determinerà automaticamente se è necessario fornire un cla e decorare la richiesta pull in modo appropriato (ad esempio, etichetta, commento). Seguire semplicemente le istruzioni fornite dal bot. Questa operazione deve essere eseguita una sola volta in tutti i repository di proprietà di Microsoft.

Inviare commenti e suggerimenti

Avete pensato a come possiamo migliorare le estensioni? È sufficiente aprire un nuovo problema!

E non dimenticare di seguire il nostro account Twitter per gli ultimi aggiornamenti.

Sognando di migliorare il mondo per gli sviluppatori? partecipa al nostro team!