Annuncio dell'estensione Docs Markdown per Visual Studio Code

Questo post è stato scritto da Adam Kinney, Senior Software Engineer del team di docs.microsoft.com.

Oggi siamo lieti di annunciare il rilascio di Docs Authoring Pack per Visual Studio Code, che rende ancora più semplice contribuire a docs.microsoft.com. Questa prima versione del pacchetto include tre estensioni:

• Docs Markdown - fornisce assistenza per la creazione di contenuti tramite Markdown, offrendo funzionalità per la formattazione del testo, l'inserimento di elenchi e tabelle, l'inserimento di collegamenti ad altri contenuti e l'aggiunta di immagini e altre risorse. A differenza di altri editor Markdown, Docs Markdown supporta le estensioni Markdown personalizzate per docs.microsoft.com, come gli avvisi e i frammenti di codice.
• DocFX - fornisce un'anteprima Markdown limitata specifica per docs.microsoft.com, che consente di controllare l'aspetto che avrà il file markdown una volta pubblicato.
• markdownlint - un linter Markdown molto diffuso di David Anson per garantire che il Markdown sia conforme alle procedure consigliate.

Funzionamento

In primo luogo, è necessario installare l'estensione da Visual Studio Marketplace. Visitare la pagina dell'estensione, quindi fare clic su Installa e seguire le istruzioni visualizzate:

Al termine, è sufficiente ricaricare Visual Studio Code, aprire un file markdown e iniziare a scrivere. Usare la combinazione di tasti Alt+M per accedere al riquadro comandi dell'estensione Docs Markdown, che consente di formattare velocemente il testo (ad esempio, per renderlo grassetto o corsivo), inserire entità Markdown standard come tabelle o elenchi numerati, nonché inserire markup specifici di docs per note, informazioni importanti e suggerimenti:

È anche possibile inserire rapidamente codice da altri file tramite un'estensione Markdown compatibile con DocFX e visualizzare in anteprima la pagina su cui si sta lavorando direttamente nell'editor:

Collabora

L'estensione è open source e qualsiasi contributo è molto apprezzato.

Per la maggior parte dei contributi è necessario accettare un accordo CLA (Contributor License Agreement) che specifica che l'utente ha il diritto di concedere, ed effettivamente concede, a Microsoft i diritti per l'uso del contributo. 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. Sarà necessario eseguire questa operazione una sola volta per tutti i repository di proprietà di Microsoft che usano il nostro CLA.

Commenti e suggerimenti

Per inviare suggerimenti per il miglioramento dell'estensione, è 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!