Introduzione a Markdown

Cos'è Markdown?

Markdown è un linguaggio di markup utilizzato per formattare documenti di tutti i tipi, creato da John Gruber e Aaron Swartz nel 2004, oggi è uno dei linguaggi più popolari tra i programmatori.

Secondo Wikipedia:

NOTA: un linguaggio di markup è un linguaggio che utilizza tags o simboli per applicare la stilizzazione al contenuto, i linguaggi di markup più popolari al mondo sono HTML, XML e Markdown.

Nell'immagine sotto puoi vedere un file formattato con Markdown nell'editor di testo Sublime Text.

Un file Markdown o MD è composto da testo semplice, è facile da capire e non ha tutto quel markup HTML che inquina il contenuto.

NOTA: MD è l'abbreviazione di Markdown.

Con Markdown puoi aggiungere la formattazione al tuo documento usando il markup dei simboli.

È importante notare che il formato Markdown è diverso dal formato utilizzato da alcuni editor WYSIWYG .

NOTA: WYSIWYG è l'abbreviazione di What You See Is What You Get . Fondamentalmente, la formattazione del contenuto avviene in tempo reale, cioè è immediatamente visibile. Per saperne di più puoi consultare questo articolo di Wikipedia.

Ad esempio, in Microsoft Word, che è un editor WYSIWYG, la formattazione del testo si verifica quando si seleziona un determinato contenuto e si preme un pulsante specifico, una combinazione di tasti o qualche opzione di menu.

In Markdown, la formattazione viene applicata utilizzando simboli come il cancelletto #, l'asterisco * e il carattere di sottolineatura _.

Questa simbologia viene utilizzata dal processore Markdown per sapere quali parole / frasi devono essere formattate durante la conversione del file in HTML.

Ad esempio, ** Voglio che questo testo sia in grassetto ** e _questo testo in corsivo_

Troppo confuso? Semplifichiamo un po '.

Quando racchiudi il contenuto con due asterischi ** lo enfatizzi in grassetto, nel secondo esempio, usiamo un trattino basso _ per applicare il corsivo.

Come modificare un file Markdown

Un file Markdown non è altro che testo, quindi qualsiasi semplice editor di testo è sufficiente per l'attività.

Tuttavia, è interessante tenere in considerazione:

• Un editor che ti permette di convertire il nostro documento Markdown in un altro formato.
• Un editor in grado di evidenziare la sintassi di Markdown.
• Un editor che mostra la conversione in HTML in tempo reale

La buona notizia è che:

• Esistono diverse applicazioni Markdown per vari sistemi operativi, tra cui, per Windows, per Linux, per Android e persino per iOS.
• Quando si tratta di Web, le cose vanno ancora meglio, diversi siti offrono applicazioni Markdown gratuite per modificare i documenti online e, soprattutto, molti hanno un convertitore in tempo reale, ovvero, mentre digiti l'applicazione, la conversione in HTML .

NOTA: Vale la pena ricordare che la formattazione di Markdown è estremamente semplice, quindi un documento formattato con questa lingua è ancora leggibile.

Markdown vs WYSIWYG

Se un editor WYSIWYG (che offre la formattazione in tempo reale) è estremamente conveniente, perché dovrei usare Markdown?

Se utilizzo un editor WYSIWYG posso premere un pulsante e avere la formattazione che desidero, perché devo digitare un documento con markup Markdown?

Diamo un'occhiata ad alcuni motivi per utilizzare Markdown:

• Markdown può essere utilizzato per creare quasi ogni tipo di documento, che si tratti di siti Web, libri, presentazioni, e-mails, documentazione tecnica e molto altro.
• A portabilidade do Markdown é excepcional. Por ser um documento de texto simples, esse, pode ser editado em qualquer aplicativo de texto. Se contrastarmos com o Microsoft Word, o formato docx é proprietário e necessita de programa específico para ser aberto, o que não acontece com o md.
• Privo del programma che usi durante la modifica del documento, un file " MD" perché modifica quello vecchio.
• Indipendentemente dal sistema operativo in uso, Windows, Mac o Android, Markdown è compatibile.
• Tieni il tuo documento accessibile anche in caso di catastrofe. Il tuo editor di testo preferito non funziona più? Il supporto è terminato? Il programma è stato pagato? Nessun problema, scegli un altro editor di testo e continua a modificare e ad accedere al tuo documento, che è estremamente importante per file come documentazione tecnica, libri e TCC.
• La gigantesca comunità di Markdown lo ha reso accessibile su una varietà di siti Web come linguaggio standard per la formattazione dei post. GitHub e Reddit sono esempi di siti famosi che utilizzano Markdown.
• Un gran numero di persone utilizza già Markdown, quindi i loro documenti formattati saranno compresi da sempre più persone.

Fare pratica

Il modo migliore per imparare è fare pratica!

È interessante che tu abbia a disposizione un editor Markdown mentre impari la sintassi della lingua.

Il modo più veloce per iniziare a praticare Markdown è usare gli editor online. Con le app Web non è necessario scaricare nulla, basta andare sul sito Web e iniziare a modificare il file md.

StackEdit, Dillinger e Editor.md (Markeditor) sono buone opzioni per iniziare.

NOTA: Apri uno degli editor di online in un'altra scheda del tuo browser per addestrare la sintassi di Markdown in tempo reale.

StackEdit

StackEdit è una delle applicazioni più complete. Oltre all'editor, fornisce anche un convertitore in tempo reale che rende HTML nel pannello di destra.

Vedere ulteriori informazioni su StackEdit nella sezione strumenti.

Dillinger

Dillinger ha un'interfaccia molto semplice, ma offre diverse opzioni per modificare il tuo documento Markdown. Oltre alla conversione in tempo reale, puoi anche esportare il file nei formati HTML e PDF

Per ulteriori informazioni su Dillinger fare clic qui.

Editor.md (Markeditor)

Editor.md è uno strumento open source, ha un convertitore da MD a HTML in tempo reale e pulsanti che ti permettono di creare un elemento Markdown con un solo clic.

Poi?

Dopo aver acquisito maggiore esperienza, puoi scaricare un'applicazione per il tuo sistema operativo e iniziare a modificare i documenti in locale.

Nella sezione "strumentitroverai un ampio elenco di applicazioni con istruzioni su come usarle e informazioni sulla compatibilità con gli elementi Markdown.

Bene, ora che hai un editor disponibile per esercitarti con Markdown, capiamo come funziona la conversione da un formato all'altro.

Come convertire un file Markdown

Comprendiamo la procedura utilizzata dalle applicazioni Markdown per convertire il tuo file md in un altro formato, solitamente HTML o PDF.

La semplicità di Markdown

Come si identifica un file Markdown? Per estensione, corretto? Di solito md o markdown.

Un file Markdown è testo semplice, non ha formattazione, non è un file crittografato, tanto meno compilato.

NOTA: questa semplicità consente ai programmi di analizzare il testo alla ricerca di simboli che identificano gli elementi Markdown.

Diverse applicazioni Markdown, oltre all'editor, hanno anche un convertitore integrato. Il convertitore è responsabile della traduzione della sintassi di Markdown in un altro formato.

Come viene eseguita la conversione

Il convertitore Markdown utilizza un Parser per scansionare il suo contenuto alla ricerca di contrassegni compatibili con Markdown; Dopo aver trovato un markup compatibile, Parser controlla se c'è una corrispondenza nel formato di output, ad esempio, un tag HTML che produce la stessa formattazione.

Di seguito puoi vedere un esempio di tabella di corrispondenza tra un marker Markdown e un tag HTML.

Nota che il formato HTML è uno dei più utilizzati quando si tratta di convertire Markdown. Il tuo file convertito in HTML può essere visualizzato in qualsiasi browser Web come Google Chrome, Mozilla Firefox e Microsoft Edge.

Nell'immagine sottostante puoi vedere una versione semplificata del processo di conversione.

NOTA: è importante notare che, in un'applicazione più robusta, i componenti possono essere separati, anche se possono essere indipendenti l'uno dall'altro. L'editor, il convertitore, il parser, ecc. L'immagine sopra è solo una semplice rappresentazione di come si svolge la procedura.

Riassumiamo la conversione in quattro passaggi.

• Per prima cosa dobbiamo creare un file Markdown, per questo aggiungiamo l'estensione md o markdown quando salviamo il documento. Durante la modifica, qualsiasi editor di testo andrà bene.
• Quindi, carichiamo il file in qualche applicazione Markdown.
• È giunto il momento di convertire in un altro formato, nel nostro caso, HTML. In questa fase è essenziale un'applicazione dedicata a Markdown.
• Visualizza il risultato della conversione. Se è HTML, apri semplicemente il file in un browser.

Alcuni punti dovrebbero essere evidenziati

• Questa procedura può variare a seconda di dove stai modificando il tuo file Markdown.
• Quando parliamo di editing semplice, cioè utilizzando qualsiasi editor generico, questi passaggi sono più evidenti.
• Nel caso degli editor online come Dillinger, StackEdit e Editor.md, c'è una fusione dei passaggi 2,3 e 4 direttamente nell'interfaccia grafica di queste applicazioni.

Utilizzando Markdown

La creazione di contenuto per Web è il modo più popolare per utilizzare Markdown. Non solo nella generazione di pagine HTML, ma anche nella creazione e modifica di post di ogni tipo, dalla creazione di semplici commenti all'elaborazione della documentazione tecnica.

Puoi anche formattare elenchi di attività, messaggi e-mails, liste della spesa e altro ancora.

Di seguito puoi vedere alcuni esempi di documenti che possono essere creati utilizzando Markdown.

Siti web

John Gruber e Aaron Swartz hanno sviluppato Markdown pensando a Internet, quindi la creazione di contenuti per Web è diventata una delle maggiori attrazioni del linguaggio.

Molte applicazioni, compatibili con Markdown, convertono già automaticamente il loro contenuto in HTML.

È possibile creare siti Web completi utilizzando la formattazione Markdown come base. Se è quello che vuoi fare, strumenti come Jekyll e MkDocs possono soddisfare le tue esigenze.

Jekyll e MkDocs sono strumenti che generano siti Web statici da documenti Markdown. Sappi che durante la creazione di siti Web, è interessante avere un minimo di familiarità con HTML, CSS e persino file di controllo delle versioni utilizzando Git.

GitHub Pages fornisce hosting gratuito per il tuo sito web statico.

Se hai bisogno di qualcosa di più robusto come un gestore di contenuti, il famoso CMS, dai un'occhiata a Ghost.

Ghost è una piattaforma gratuita e open source per bloggers. Lo strumento ha anche un editor Markdown integrato.

Usi WordPress? I siti ospitati su WordPress.com hanno già il supporto per Markdown, tuttavia puoi usare plugin Jetpack per i siti che si trovano su altri server di hosting.

Formatta il testo

La semplicità di Markdown rinuncia a tutte le opzioni appariscenti di un editor WYSIWYG, come Microsoft Word, ma offre comunque una formattazione sufficiente per modificare i tuoi documenti.

Grassetto, corsivo e barrato sono supportati dalla lingua, oltre, ovviamente, a elenchi, titoli, blockquotes e molto altro.

Un altro vantaggio della formattazione dei documenti utilizzando Markdown è la possibilità di convertirli praticamente in qualsiasi altro formato di file di testo.

Di seguito è riportato un elenco di applicazioni per la creazione / modifica di documenti Markdown:

• Windows: ghostwriter o Markdown Monster
• Linux: ReText o ghostwriter
• Mac: MacDown, iA Writer o Marked
• Web: Dillinger o StackEdit
• iOS / Android: iA Writer

Appunti

Markdown è il linguaggio perfetto per prendere appunti.

Di seguito è riportato un elenco di applicazioni compatibili con Markdown.

• Notable: si distingue per la sua compatibilità con diverse piattaforme.
• Bear: siamo entrati nel territorio di Apple, Bear è compatibile con Mac e iOS, non usa Markdown di default, ma puoi attivarlo. Bear è molto simile a Evernote.
• Simplenote: è gratuito, è semplice e memorizza le note. Disponibile su tutte le piattaforme.
• Boostnote: più focalizzato sui programmatori, oltre ad avere codice open source.

E Evernote? OneNote? Qualcuno...?

Così è...

Quando si tratta di app per prendere appunti, Evernote e OneNote sono, senza dubbio, le più popolari. Sfortunatamente, i due programmi, per impostazione predefinita, non forniscono supporto per Markdown.

Nel caso di Evernote puoi usare Markdown Here o Marxico.

NOTA: Markdown Here è un'estensione per il tuo browser che ti permette di creare emails usando la sintassi Markdown. Puoi utilizzare questa stessa estensione sul sito web di Evernote.

Libri

Cosa intendi per scrivere libri usando Markdown?

Esatto, servizi come Leanpub utilizzano file Markdown come base, la conversione viene eseguita in EPUB, MOBI e PDF.

Non ti piacciono molto gli e-book?

Con il file del tuo libro elettronico generato puoi caricarlo su altri servizi come Kindle Direct Publishing e produrre copie fisiche.

Le presentazioni di slides

Sì, hai letto bene, puoi creare presentazioni slides usando Markdown.

Remark, Cleaver e Landslide sono strumenti che generano presentazioni slides direttamente nel tuo browser, tutti usano file md come base.

Preferisci usare le app? In macOS puoi consultare Marked o Deckset. Su Windows possiamo convertire Markdown in slides usando Pandoc.

Può sembrare una perdita di tempo generare presentazioni usando il markup Markdown, tuttavia, con un po 'di pratica scoprirai che è molto più facile e veloce che usare uno strumento come PowerPoint o Keynote.

E-mails

La maggior parte dei fornitori di e-mail fornisce un editor WYSIWYG integrato nell'interfaccia, ma ammettiamolo, molti lasciano a desiderare, da un lato c'è molta complessità, dall'altro mancano le opzioni di formattazione.

E adesso?

Markdown Here è la soluzione per questi casi. Un'estensione per il tuo browser che ti permette di scrivere il tuo e-mails usando la formattazione Markdown.

È gratis?

Sì, Markdown Here è gratuito, open source e converte immediatamente Markdown in HTML.

Documentazione tecnica

Markdown e documentazione tecnica vanno di pari passo. Innumerevoli aziende utilizzano i file md per archiviare la loro documentazione.

GitHub ha migrato i suoi documenti a Markdown con il supporto dello strumento Jekyll. Inoltre, uno degli archivi più famosi al mondo, README.md di GitHub è composto da Markdown.

NOTA: GitHub utilizza una piccola variante di Markdown chiamata GitHub-flavored Markdown.

Per la creazione della documentazione tecnica, gli strumenti seguenti possono aiutarti:

• Jekyll: Genera documentazione da file Markdown, è la scelta di GitHub Pages.
• MkDocs: Semplice, veloce e facile da usare. La base per la documentazione sono i file .md, la configurazione utilizza i file YAML.
• Docusaurus: Generatore di siti Web statici, uno dei migliori strumenti per la creazione di documenti. Docusaurus è stato sviluppato da Facebook, supporta il controllo delle versioni, la ricerca di documenti e persino le traduzioni.
• Read The Docs: Genera siti di documentazione basati su file Markdown.
• VuePress: Dal nome si capisce che ha qualcosa a che fare con Vue, così com'è, VuePress è un generatore di siti web statici finalizzato alla scrittura di documentazione tecnica.

Sapori di Markdown

Immagina tutti i diversi dialetti che esistono in una lingua, slang, pronunciamenti, accenti. Anche per i madrelingua, a volte è difficile capire alcune cose.

Così com'è, come con le lingue, anche le implementazioni di Markdown in diversi programmi possono variare, anche se la differenza è sottile, può comunque causare confusione.

Le varianti di Markdown sono chiamate Flavors, ad esempio, GitHub utilizza una versione leggermente più robusta di Markdown chiamata GitHub-flavored Markdown o GFM.

Alcune applicazioni usano solo sintassi di base, altre usano una combinazione di sintassi di base e sintassi estesa e, infine, ci sono quelle che implementano sporadicamente elementi di entrambe.

Cosa fare?

Il modo migliore per comprendere un'applicazione è consultare la sua documentazione. Puoi anche usare la buona vecchia tattica per tentativi ed errori. Vedi anche il nostro elenco di strumenti in cui elenchiamo quali elementi di Markdown sono compatibili con ciascuna applicazione.

Alla fine della giornata, l'opzione migliore è usare un programma che offra la massima compatibilità possibile, come Dillinger o StackEdit.

Alcuni esempi di sapori da Markdown sono, GFM (GitHub-flavored Markdown); MultiMarkdown; Markdown Extra, Kramdown.

Conclusione

In questo articolo hai imparato le basi di Markdown, cosa puoi fare con esso e le sue diverse implementazioni.

Il passo successivo è imparare la sintassi di base della lingua o, se sei già sicuro, consulta la sezione strumenti per iniziare a usare Markdown.