Github Markdown -Cheatsblatt
Der Standard -Markdown
Markdown ist ein Standard, der von John Gruber entwickelt wurde. Das Hauptziel bei Markdown besteht darin, die Datei möglich zu ermöglichen, auch in reinem Text zu lesen. Wenn Sie in einem Nur-Text-Editor nachsehen möchten, sollten Sie es leicht lesen, es zu lesen. Dies ist sehr hilfreich für Benutzer von VIM und ähnlich. Beachten Sie und denken Sie daran, dass dies ein Standard für das Ändern von Textdateien ist. Es ersetzt HTML nicht. Stattdessen erstellen Sie es, um HTML zu erstellen, wo es nützlich ist. Im Fall von GitHub formatieren sie die Readme -Datei auf der Website. Solange Sie dem Standard folgen, können Sie sich sicher fühlen, dass er gut aussieht.
Da Github nur wenige Erweiterungen hinzugefügt hat, sollten Sie zunächst ein Markdown -Cheatsblatt verwenden und von dort ausgehen. Hier ist eine Liste der häufigsten.
| Markdown | Erweiterungen | Ergebnis |
| # (1 pro Level) | Überschriften | |
| * | Kursivschrift | |
| ** | Deutlich | |
| > | Blockquote | |
| 1. (usw.) | Bestellliste | |
| - | Ungeordnete Liste | |
| 'Code' | Dein Code | |
| "'' | MD-EXT | Start und beenden Sie einen Codeblock |
| - | Horizontale Regel | |
| [Beschreibung] (https: // www.Beispiel.com) | Ein Name in Square und URL in regulären Klammern | |
| ![ALT -Text] (Bild.png) | Gleiches Link zu einem Bild | |
| [1] | MD-EXT | Eine Fußnote |
Die Listen können verschachtelt werden.
Weitere Erweiterungen zum regulären Markdown haben Sie die oben genannten Codeblöcke. Sie werden nicht immer von Diensten unterstützt.
| Markdown | Erweiterungen | Ergebnis |
| ### Überschrift #Custom-ID | MD-EXT | Eine Überschrift, die Sie durch seine ID ansprechen können |
| Begriff: Definition | MD-EXT | Eine Liste von Begriffen mit Definitionen |
| ~ Falscher Text ~ ~ | MD-EXT | STICHTHROUGH -Text |
| - [x] Aufgabe zu erledigen | MD-EXT | Eine Aufgabenliste, die Sie ankreuzen können |
Die Tabelle ist sehr einfach, aber Sie benötigen mehrere Zeilen, um sie anzuzeigen: Tabelle:
| Name | Wert || ----------- | ---------- |
| Matten | 100 |
Github -Erweiterungen.
Github hat einige Erweiterungen hinzugefügt, um es einfacher zu machen, Links zu anderen Personen und Projekten zu behandeln. Einige davon sind die zuvor erwähnten Tabellen. Derjenige, der Ihnen am meisten hilft, ist die Auto-Link-Erweiterung. Es schafft selbst einen Link, wenn Sie ihn auf GitHub verwenden.
Andere sind Tabellen und Aufgabenlistenelemente. Diese sind bequem, um Ihre Aufgaben in Projekten im Auge zu behalten. Der letzte, der erwähnen kann. Mit Hilfe dieser Erweiterung werden einige Tags beim Rendern für HTML gefiltert. Diese Tags können seltsame Auswirkungen haben, wenn sie zu GitHub rendern.
Möglichkeiten zur Erforschung von Github -Markdown
Wenn Sie es verwirrend finden, können Sie auch zur Github-Seite gehen und den integrierten Editor verwenden. Wenn Sie es verwenden, wird es einige Funktionen automatisch erfüllen. Dies funktioniert nur für Probleme, aber Sie können es verwenden, um einige Dinge herauszufinden, die Emojis erscheint als Liste, wenn Sie einen Dickdarm eingeben (:).
Sie finden auch ein Projekt auf Github, das eine hervorragende Readme -Datei hat und sie an Ihr lokales Laufwerk klonen. Von dort aus können Sie die Datei mit einem beliebigen Editor erkunden. Für die großen Redakteure, EMACs und VIM, gibt es Unterstützung für den Aufschlag durch Erweiterungen.
Wenn Sie VIM verwenden, können Sie eine Syntax-Hervorhebungsverlängerung von GitHub, VIM-Markdown, einsetzen. Diese Erweiterung zeigt Ihnen, dass Sie den Code richtig gemacht haben. Um zu sehen, wie es aussieht, wenn Sie fertig sind, können Sie auch die Live -Marke -Erweiterung erhalten. Auf diese.
Mit EMACs haben Sie ungeduldiger Mode, Live-Down-Mode und Echtzeit-Präview. Sie alle zeigen Ihre resultierende Seite in einem Browser, während Sie eingeben. Der erste erfordert weniger Bibliotheken als letztere, benötigt jedoch ein zusätzliches Code-Snippet zum Ausführen.
Abschluss
Auch wenn Markdown eine kleine und absichtlich einfache Spezifikation ist, kann es ein wenig verwirrend sein, mit zu beginnen. Der beste Weg zum Lernen ist die Verwendung eines Cheat -Blattes und schreiben Sie Ihr Markdown -Dokument. Sie können Ihre Readme aktualisieren.MD auf GitHub, und Sie können viel Unterstützung von den integrierten Funktionen Ihrer Redakteure erhalten. Als Randnotiz unterstützt GitHub auch Emojis, die Sie Ihrem Dokument hinzufügen können. Sie können das Cheat -Blatt verwenden, um herauszufinden, welche sie sind.
Download Markdown-Scatsheethere