È possibile utilizzare Markdown tagging per migliorare la leggibilità di un readme di un progetto o le celle Markdown nei notebook Jupyter. Si notano le differenze tra Markdown nei file readme e nei notebook.
Rubriche: Utilizzare #s seguito da uno spazio vuoto per titoli di notebook e rubriche di sezione:
#
titolo
##
principali rubriche
###
sottovoci
####
4th sottovoci di livello
Enfasi: Utilizzare questo codice: Bold: __string__
o **string**
, Italic: _string_
o *string*
, Strikethrough: ~~string~~
Simboli matematici: Utilizzare questo codice: $ mathematical symbols $
Font monospazio: Testo Surround con virgoletta posteriore (`). Utilizzare il monospazio per il percorso file e i nomi dei file e per gli utenti di testo inserire o far vedere gli utenti del testo.
Line break: A volte Markdown non fa pause di linea quando le vuoi. Mettere due spazi alla fine della riga, oppure utilizzare questo codice per una interruzione di linea manuale: <br>
Rientro in entrata: Utilizzare un segno più grande (>
) e poi uno spazio, quindi digitare il testo. Il testo è rientrato e ha una linea orizzontale grigia a sinistra di esso fino al successivo ritorno in carrozza.
Punti elenco: utilizzare il trattino (-
) con uno spazio dopo di esso o uno spazio, un trattino e uno spazio (-
), per creare un punto elenco circolare. Per creare un sottoproiettile, utilizzare una scheda seguito un trattino e uno spazio. È anche possibile utilizzare un asterisco invece di un trattino, e funziona lo stesso.
Elenchi numerati: Start con 1.
seguito da uno spazio, poi il tuo testo. Il ritorno di hit e la numerazione è automatico. Inizia ogni riga con qualche numero e un periodo, poi uno spazio. Scheda a rientro per ottenere la sottonumerazione.
Caselle di spunta nei file readme: utilizzare questo codice per una casella non selezionata: - [ ]
Utilizzare questo codice per una casella selezionata: - [x]
Tabelle in readme files: Utilizzare questo codice:
| Heading | Heading |
| ----| ----|
| text | text |
| text | text |
Grafica nei notebook: Disegni e getta le immagini alla cella Markdown per allegarla al notebook. Per aggiungere immagini ad altri tipi di celle, utilizzare la grafica ospitata sul web con questo codice, sostituendo url / name con l'URL completo e il nome dell'immagine: <img src="url/filename.gif" alt="Alt text" title="Title text" />
Grafica in file readme: Utilizzare questo codice: ![Alt text](url/filename.gif "Title text")
Le forme geometriche: Utilizzare questo codice con un numero di riferimento decimale o esadecimale da qui: UTF-8 Forme Geometriche &#reference_number;
Linee orizzontali: Utilizzare tre asterischi: ***
Link interni: Per collegarsi ad una sezione, aggiungere un ancoraggio sopra il titolo della sezione e quindi creare un link.
Utilizzare questo codice per creare un ancoraggio: <a id="section_ID"></a>
Utilizzare questo codice per creare il link: [section title](#section-ID)
Assicurarsi che section_ID sia univoco all'interno del notebook o del readme.
In alternativa, per i notebook è possibile ignorare la creazione di ancoraggi e utilizzare questo codice: [section title](#section-title)
Per il testo tra parentesi, sostituire spazi e caratteri speciali con un trattino e rendere tutti i caratteri minuscoli.
Prova tutti i link!
Link esterni: Utilizzare questo codice: [link text](http://url)
Per creare un link che si apre in una nuova finestra o scheda, utilizzare questo codice: <a href="http://url" target="_blank" rel="noopener noreferrer">link text</a>
Prova tutti i link!
Argomento principale: Progetti