Eine großartige „README.md“ ist der Unterschied zwischen einem erfolgreichen und einem aufgegebenen Open-Source-Projekt. Und eine der besten Möglichkeiten, API-Dokumentation, Funktionsvergleiche oder Konfigurationsoptionen darzustellen, ist die Verwendung von Tabellen.
Leider macht Standard-Markdown Tabellen nicht einfach.
Der Kampf um die Markdown-Tabelle
Das manuelle Schreiben einer Markdown-Tabelle sieht folgendermaßen aus:
„Abschlag | Eigentum | Geben Sie | ein Beschreibung | |---|---|---| | id | Zeichenfolge | Der eindeutige Bezeichner | | Zeitüberschreitung | Nummer | Zeit in Millisekunden | „
Wenn Sie einer Zeile eine lange Beschreibung hinzufügen, wird die gesamte Tabelle in Ihrem Code-Editor optisch falsch ausgerichtet, was die Pflege und Lesbarkeit enorm erschwert.
Visuelle Generierung
Der effizienteste Arbeitsablauf ist die Verwendung eines visuellen Rasters. Mit unserem [Markdown-Tabellengenerator](/en/markdown-table-generator) können Sie Ihre Inhalte in eine tabellenähnliche Oberfläche eingeben.
Sie können Spalten hinzufügen, Zeilen löschen und auf natürliche Weise tippen. Sobald Sie fertig sind, generiert das Tool sofort die perfekt verteilte, sauber formatierte Markdown-Syntax. Sie kopieren es einfach und fügen es in Ihre README-Datei ein.
Hören Sie auf, sich mit Pipe-Zeichen (`|`) und Bindestrichen herumzuschlagen, und beginnen Sie mit der visuellen Erstellung Ihrer Tabellen!