Quando documentate il vostro progetto GitHub, non dovete fare affidamento su un testo continuo semplice e uniforme. Con il Markdown, in parte interno, i file readme e la documentazione possono essere disposti davvero bene.
- Che cos'è il Markdown?
- Titoli e markup
- Link e immagini
- Liste e tabelle
- Emoji e varie
Cos'è il Markdown?
Il Markdown è fondamentalmente una cosa abbastanza semplice, un linguaggio di markup. Proprio come l'HTML: l'HTML era un modo "facile" per progettare pagine web - facile rispetto ai linguaggi di programmazione. Ma alla fine, la sintassi HTML non è adatta a testi continui più lunghi. Ci sono costantemente parentesi, virgolette e certe parole chiave che aspettano di essere impostate sul carattere esatto. Se, per esempio, vuoi scrivere la parola "bold" in grassetto: bold
Markdown semplifica notevolmente la questione, un semplice **bold** viene visualizzato sulle pagine abilitate a Markdown proprio come la variante HTML. Per essere più precisi: è tradotto nella variante HTML. Il markup Markdown è molto più facile da ricordare e, soprattutto, da digitare.
Ora, non c'è solo una manifestazione di Markdown, anche se la maggior parte degli elementi sono standardizzati. In ogni caso, Github offre alcune opzioni speciali oltre a questo, per esempio per poter menzionare gli utenti Github con una formattazione evidenziata o per visualizzare chiaramente il codice e i comandi.
Di seguito, potete vedere quali elementi usare e come creare un file readme ben formattato:
- Überschriften
- Textauszeichnung (fett, kursiv, durchgestrichen)
- Links
- Bilder
- Listen (ungeordnet, nummeriert, ToDo)
- Tabellen
- Emojis
Außen vor bleiben Referenzen auf Nutzer (@nutzer) und Pull Requests, da diese in normalen Dateien nicht funktionieren, sondern nur in Beschreibungen und Kommentaren von Pull Requests und Issues.
Überschriften und Auszeichnungen
Wenn Sie in GitHub ein Projekt anlegen, bekommen Sie auch gleich eine vorgefertigte, leere Datei "LIESMICH.md" - wobei das "md" natürlich für Markdown steht. Öffnen Sie den Editor für die Datei und beginnen Sie zum Beispiel mit den Überschriften, um den Artikel zu strukturieren:
# Mein Projekt
## Installation