Annuncio dell'estensione Docs Markdown per Visual Studio Code
Questo post è stato scritto da Adam Kinney, Senior Software Engineer nel team docs.microsoft.com.
Oggi siamo lieti di annunciare il rilascio del docs Authoring Pack di per Visual Studio Code, rendendo più semplice che mai contribuire a docs.microsoft.com. Questa prima versione del pacchetto include tre estensioni:
- Docs Markdown: fornisce assistenza per la creazione di Markdown, tra cui la formattazione di testo, l'inserimento di elenchi e tabelle, l'inserimento di collegamenti ad altri contenuti e l'aggiunta di immagini e altri asset. A differenza di altri editor Markdown, Docs Markdown supporta estensioni Markdown personalizzate per docs.microsoft.com, ad esempio avvisi e frammenti di codice.
- DocFX: offre un'anteprima markdown specifica di docs.microsoft.comlimitata per vedere l'aspetto del file Markdown quando viene pubblicato.
- markdownlint: un linter Markdown popolare di David Anson per garantire che Markdown segua le procedure consigliate.
Prima di tutto, è necessario installarlo da Visual Studio Marketplace. Quando si passa alla pagina dell'estensione , è sufficiente fare clic su Installa e seguire i messaggi sullo schermo:
Al termine, è necessario 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 Markdown docs, consentendo di formattare rapidamente il testo (ad esempio, impostarlo in grassetto o corsivo), inserire entità Markdown standard, ad esempio un elenco numerato o una tabella, nonché inserire commenti specifici della documentazione per note, informazioni importanti e suggerimenti:
È anche possibile inserire rapidamente codice da altri file tramite un 'estensione Markdown compatibile con DocFXe visualizzare in anteprima la pagina su cui si sta lavorando direttamente nell'editor:
L'estensione è open sourcee sono stati accolti tutti i contributi.
La maggior parte dei contributi richiede l'accettazione di un Contratto di licenza collaboratore (CLA) che afferma che l'utente ha il diritto di concedere, e in realtà, i diritti per l'uso del contributo. 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. È necessario eseguire questa operazione una sola volta in tutti i repository di proprietà di Microsoft usando il contratto di licenza microsoft.
Avete pensato a come possiamo migliorare l'estensione? È 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!