YamlBox

Web & Kodierung · 5 Min. gelesen

Markdown Tabellen: Generieren Sie sie, anstatt Rohre zu zählen

Eine Markdown-Tabelle ist ein Raster aus Zellen, die mit Strichen und Strichen geschrieben sind, und es ist der einzige Teil des Markdowns, der wirklich unangenehm von Hand zu schreiben ist. Das Zählen von Pipes, die Beibehaltung der gleichen Breite der Trennzeichenzeile wie die Kopfzeile und das Escapen eines Pipes, das innerhalb einer Zelle erscheint, konkurrieren alle um Aufmerksamkeit. Durch die Generierung der Tabelle werden alle drei Probleme auf einmal beseitigt.

Aktualisiert

Die Syntax, in einem Beispiel

                | Tool          | Input       | Offline |
| :------------ | :---------: | ------: |
| YAML to JSON  | YAML        | yes     |
| JWT decoder   | JWT         | yes     |
              

Die erste Zeile ist die Kopfzeile, die zweite die Trennzeile und alles danach sind Daten. Doppelpunkte in der Trennzeichenzeile legen die Ausrichtung fest: `:---` links, `:---:` in der Mitte, `---:` rechts. GitHub und die meisten Renderer akzeptieren eine führende und eine nachgestellte Pipe als optional, aber durch deren Einbeziehung bleibt der Rohtext in einem Editor lesbar.

Die drei Dinge, die den Tisch sprengen

  • Eine Pipe innerhalb einer Zelle – maskieren Sie sie als `\|`, sonst wird die Zeile in eine Spalte zu viel aufgeteilt.
  • Eine Trennzeile mit der falschen Anzahl von Spalten – die Kopfzeile wird verschoben und die Tabelle wird falsch ausgerichtet dargestellt.
  • Eine leere Zeile innerhalb der Tabelle – der Renderer behandelt sie als Ende der Tabelle und gibt den Rest als Text aus.

Für Code und reguläre Ausdrücke in Zellen ist das Escapen am wichtigsten: `a|b` und `\bfoo\b` benötigen beide Aufmerksamkeit, bevor sie glücklich in einer Tabelle leben können.

Daten aus einer Tabellenkalkulation abrufen

Der natürliche Arbeitsablauf besteht darin, eine Auswahl aus einer Tabelle oder einem CSV-Export einzufügen und den Generator die Angebotserstellung und Ausrichtung durchführen zu lassen. Das ist schneller und weniger fehleranfällig als das Eintippen von Zeilen und bewältigt auch die langweiligen Fälle – variable Spaltenbreiten, rechtsbündige Zahlen, Zellen, die Kommas enthalten. Schneiden Sie abschließende leere Spalten vor dem Einfügen ab, um eine Tabelle mit Phantomspalten zu vermeiden, die als Lücken dargestellt werden.

Wann man einen Tisch nicht benutzen sollte

Tabellen dienen dem Vergleich: Feature-Matrizen, Flag-Referenzen, Kompatibilitätslisten, Umgebungsvariablen. Sie eignen sich schlecht für Prosa, schlecht für lange Beschreibungen und sind auf schmalen Bildschirmen schmerzhaft, da Markdown kein Reaktionsverhalten aufweist – der Renderer scrollt entweder horizontal oder quetscht Spalten in unleserliche Splitter. Wenn eine Zelle einen Absatz benötigt, verwenden Sie stattdessen eine Definitionsliste, eine Überschrift pro Eintrag oder eine Aufzählungsliste. Eine Tabelle, die niemand auf einem Telefon lesen kann, ist schlimmer als die Liste, die sie ersetzt hat.

Generieren und dann an einer beliebigen Stelle einfügen

Die Ausgabe ist ein einfaches Markdown, sodass sie direkt in eine README-Datei, eine Pull-Request-Beschreibung, eine Wiki-Seite, ein Jira-Ticket oder einen Kommentar eingefügt wird. Der YamlBox-Markdown-Tabellengenerator läuft im Browser, richtet Spalten für Sie aus, maskiert Pipes und arbeitet offline weiter – so können Sie interne Daten einfügen, ohne sie irgendwo zu veröffentlichen.

Markdown Tabellengenerator – häufig gestellte Fragen

Wie füge ich ein Pipe-Zeichen in eine Markdown-Tabellenzelle ein?

Escapen Sie es mit einem Backslash – `\|` – andernfalls behandelt der Renderer es als das Ende der Zelle. Generatoren erledigen dies automatisch, was der Hauptgrund dafür ist, Tabellen mit einem Werkzeug und nicht von Hand zu erstellen.

Wie richte ich eine Spalte im Markdown aus?

Verwenden Sie Doppelpunkte in der Trennzeichenzeile: `:---` für links, `:---:` für die Mitte und `---:` für rechts. Die Ausrichtung gilt für die gesamte Spalte. Richten Sie daher numerische Spalten rechts und Text links aus, um ein möglichst gut lesbares Ergebnis zu erzielen.

Warum wird meine Markdown-Tabelle nicht gerendert?

Überprüfen Sie drei Dinge: Die Trennzeile hat genau so viele Spalten wie die Kopfzeile, es gibt keine Leerzeile in der Tabelle und die Kopfzeile steht direkt vor der Trennzeile. Jeder dieser drei Punkte unterbricht das Rendern im Abschlag mit der Geschmacksrichtung GitHub.

In diesem Beitrag erwähnte Tools

Durchsuchen Sie die vollständige Liste der 19-Tools

Weitere Artikel zum Lesen

Alle 19 Beiträge →