Cuando documentes tu proyecto de GitHub, no tienes que confiar en el texto continuo y uniforme. Con la parte interna de Markdown, los archivos readme y la documentación se pueden maquetar muy bien.
- ¿Qué es Markdown?
- Encabezados y marcas
- Enlaces e imágenes
- Listas y tablas
- Emojis y varios
¿Qué es Markdown?
Markdown es básicamente una cosa bastante simple, un lenguaje de marcado. Al igual que el HTML: el HTML solía ser una forma "fácil" de diseñar páginas web, fácil en comparación con los lenguajes de programación. Pero al final, la sintaxis HTML no es adecuada para textos continuos más largos. Constantemente hay paréntesis, comillas y ciertas palabras clave que esperan ser ajustadas al carácter exacto. Si, por ejemplo, quieres escribir la palabra "negrita" en negrita: negrita
Markdown simplifica el asunto considerablemente, una simple **negrita** se muestra en las páginas habilitadas para Markdown al igual que la variante HTML. Para ser más precisos: se traduce en la variante HTML. El marcado Markdown es mucho más fácil de recordar y, sobre todo, de teclear.
Ahora, no existe una única manifestación de Markdown, aunque la mayoría de los elementos estén estandarizados. En cualquier caso, Github ofrece algunas opciones especiales más allá de eso, por ejemplo para poder mencionar a los usuarios de Github con un formato destacado o para mostrar claramente el código y los comandos.
En lo que sigue, verás qué elementos utilizas y cómo crear un archivo readme con un buen formato:
- Ü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