Markdown is het formaat waarin ik bijna alles schrijf - README's, plugin documentatie, release notes, pull request beschrijvingen, de changelog voor WP Adminify, de helft van mijn interne notities Het gaat uit de weg voor elke construct behalve een Op het moment dat een tabel erbij betrokken is, stop ik met schrijven en begin ik met het tellen van pipe karakters, en de stroom is weg Voeg een kolom toe aan een tabel met vijf rijen en je bent zes regels met de hand aan het bewerken, plus de scheidingstekenrij, en je weet niet of je het goed hebt totdat de pagina weergeeft.
tl;dr: de Markdown-tabelgenerator geeft u een raster in spreadsheetstijl, genereert geldige GitHub Flavored Markdown terwijl u typt, en importeert CSV, spreadsheetpasta of een bestaande Markdown-tabel, zodat u deze kunt herstructureren Stel de uitlijning per kolom in met één klik en exporteer Markdown, HTML of CSV. Alles draait in uw browser.
De tool bestaat omdat tabelsyntaxis het enige deel van Markdown is waar het bronformaat actief tegen bewerken vecht Deze gids behandelt hoe GFM-tabellen werken, de regels die beslissen of de jouwe renders geeft, de ontsnappende traps die rijen breken en hoe je de generator voor de workflows gebruikt. Tabellen komen meestal uit: een spreadsheet, een queryresultaat of een tabel die iemand al heeft geschreven.
Wat is een Markdown tabel?
Een Markdown-tabel bestaat uit drie ingrediënten die in een vaste volgorde zijn gestapeld: een koprij, een scheidingstekenrij en nul of meer hoofdrijen. Tabellen maken helemaal geen deel uit van de kernmarkering - ze zijn een uitbreiding gedefinieerd door de GitHub Flavoured Markdown-specificatie, daarom kan een tabel renderen op GitHub en komen als letterlijke pijpen elders Cellen worden gescheiden door pijp karakters, en elke rij beslaat precies één lijn.
| Tool | Category | Offline |
| --- | --- | --- |
| JSON Formatter | Coding | Yes |
| YAML to JSON | Data | Yes |
De scheidingstekenrij is het deel dat er een tabel van maakt in plaats van een alinea met pijpen Het moet de tweede regel zijn, het moet bestaan uit koppeltekens met optionele dubbele punten, en het moet hetzelfde aantal cellen hebben als de koptekst. Verkrijg een van de verkeerde en de renderer behandelt het hele blok als gewone tekst - daarom " mijn tabel wordt weergegeven als platte tekst en quot; is bijna altijd een probleem met de scheidingstekensrijen.
Tabellen maken geen deel uit van de originele CommonMark-specificatie Ze kwamen aan als een GitHub Flavoured Markdown-extensie en werden vervolgens bijna overal overgenomen: GitHub, GitLab, Bitbucket, Obsidian, Notion, Docusaurus, MkDocs, VitePress, Hugo, Jekyll, Discord en de meeste static-site generatoren. " Bijna & quot; is het werkwoord. Een minimale CommonMark-renderer zonder extensies zal uw tabel weergeven als letterlijke pijpen, en de oplossing is om in plaats daarvan HTML te verzenden - wat de generator met één klik op de uitvoertabbladen kan doen.
Waarom de syntaxis moeilijker te onderhouden is dan het lijkt
Het lezen van een Markdown tabel is eenvoudig Het onderhouden van een is waar de kosten verbergt, en het komt van vier plaatsen.
Structuur leeft in interpunctie. Er is geen celgrens behalve een teken dat ook voorkomt in reguliere expressies, shell-opdrachten en TypeScript-verenigingstypen. Elk van deze in een cel moet worden ontsnapt, anders krijgt de rij stilletjes een kolom.
Uitlijning wordt gecodeerd bij plaatsing van de dubbele punt. Een dubbele punt aan de linkerkant betekent links uitgelijnd, een dubbele punt aan beide kanten betekent gecentreerd, een dubbele punt aan de rechterkant betekent rechts uitgelijnd Er is geen trefwoord om het te onthouden, en het verschil tussen ---: en :--- is één personage op rij, niemand leest goed.
Bewerken is multi-line. Een kolom toevoegen betekent elke rij plus de scheidingsteken aanraken Rijen opnieuw ordenen betekent knippen en plakken zonder visuele feedback Een kolom verwijderen is een zoektocht naar de n-de pijp op elke regel.
Uitlijning van de bron is handmatig. Gevoerde kolommen zijn niet vereist - renderers negeren extra spaties - maar ongevoerde tabellen zijn ellendig om in een diff te lezen, dus mensen vullen ze met de hand op en vullen ze vervolgens opnieuw op elke keer dat een cel & # 39; s inhoud groeit.
Een rasterbewerker verwijdert ze alle vier Je bewerkt cellen; de syntaxis wordt gegenereerd Dat is het hele uitgangspunt van de tool.
Hoe de Markdown Table Generator te gebruiken
Stap 1: Haal uw gegevens in het raster
Drie routes naar binnen, afhankelijk van waar de gegevens al leven.
Typ het. Het raster opent met een gevuld monster Overschrijf de cellen, of druk op Clear voor een lege drie-bij-drie en begin fris.
Plakken uit een spreadsheet. Open het deelvenster Importeren en plak een gekopieerd bereik van Excel, Google Spreadsheets, Numbers of LibreOffice Spreadsheets zetten tab-gescheiden tekst op het klembord, en de importeur detecteert dat automatisch - u hoeft niet te vertellen welke scheidingsteken u gebruikt.
CSV plakken of een bestaande tabel. Hetzelfde paneel accepteert CSV, puntkomma-gescheiden export (de standaard in veel Europese locales), pipe-gescheiden tekst, en Markdown tabellen Als de tekst eruitziet als een Markdown tabel - een header lijn gevolgd door een scheidingsteken rij - wordt het geparseerd als een, inclusief de kolom uitlijningen, zodat u een tabel uit een README kunt laden, herstructureren, en plak het terug.
CSV import volgt de RFC 4180 regels in plaats van naïef op te splitsen op komma's Een geciteerd veld kan komma's, regeleindes en dubbele aanhalingstekens bevatten die staan voor een letterlijk aanhalingsteken Dat doet er meer toe dan het klinkt: elke export met een adres, een beschrijving of een prijs in een locale die komma's gebruikt, zal een naïeve splitsing verbreken, en je zult het pas merken als een kolom één cel te kort is Als je CSV groot genoeg is dat je het wilt inspecteren voordat je het importeert, de CSV-kijker opent het eerst in een sorteerbaar raster.
Stap 2: Vorm de tafel
De bedieningselementen rond het elektriciteitsnet dekken de bewerkingen die pijnlijk zijn bij ruwe Markdown:
- Rij en Kolom toevoegen aan het einde van het raster.
- De pijlen naast elke rij verplaatsen deze naar boven of naar beneden - handig voor het bestellen van een vergelijkingstabel op basis van wat u ook hebt besloten, het belangrijkst is.
- De min-knop op een rij of kolomkop verwijdert deze, in elke rij tegelijk.
- Transponeren wisselt rijen en kolommen. Gegevens die uit een rapport worden geplakt, zijn vaak op de verkeerde manier georiënteerd voor een document, en transponeren is één klik in plaats van een volledig hertype.
Stap 3: Uitlijning per kolom instellen
Elke kolomkop draagt drie uitlijnknoppen: links, midden, rechts Klik op één om deze toe te passen, klik er nogmaals op om terug te keren naar de renderer' s standaard De generator schrijft de bijbehorende dubbele punten in de scheidingstekenrij.
Uitlijning is het waard om bewust te gebruiken Numerieke kolommen - prijzen, tellingen, percentages, duur - lees veel beter rechts uitgelijnd, omdat de cijfers op één lijn liggen op plaatswaarde Korte statuswaarden zien er netjes gecentreerd uit Tekst hoort links Dit is geen decoratie; een rechts uitgelijnde kolom met getallen is echt sneller om naar de grootste waarde te scannen.
Stap 4: Kies het uitvoerformaat en kopieer
Drie uitgangstabbladen:
Markdown produceert GFM. De Gewatteerde kolommen toggle regelt of cellen zijn opgevuld met spaties, zodat de ruwe bron op één lijn staat in een monospace-editor. Opvulling verandert niets aan hoe de tabel wordt weergegeven - het is puur voor degene die het bestand in een diff leest. Buitenpijpen bestuurt de voor- en achterpijp op elke rij; beide stijlen zijn geldig, en de leading-pipe-stijl is veruit de meest voorkomende conventie.
HTML produceert een <table> van <thead> en <tbody> en inline text-align stijlen die overeenkomen met uw kolomuitlijningen Gebruik het voor renderers die geen tabelondersteuning hebben, voor e-mailsjablonen of wanneer u dat nodig heeft colspan en multi-line cellen die Markdown niet kan uitdrukken Als u de andere kant op wilt gaan en een tabel uit een webpagina wilt tillen, moet HTML naar markdown behandelt het.
CSV geeft u het raster terug als gegevens, correct geciteerd, voor plakken in een spreadsheet of toevoeren aan een script.
Kopieer naar het klembord of download als a .md, .html, of .csv bestand.
De ontsnappende regels die feitelijk tabellen breken
Twee tekens veroorzaken bijna elke kapotte Markdown-tabel, en beide worden automatisch afgehandeld door de generator, maar u moet de regels kennen voor de tabellen die u met de hand bewerkt.
De pijp. Een letterlijke pijp in een cel moet worden geschreven als \|. Zonder de backslash ziet de renderer een kolomscheider en krijgt je rij een cel, waardoor elke kolom erna wordt weggegooid. Dit bijt het hardst in technische documentatie, waar cellen legitiem dingen bevatten zoals string | null, grep foo | wc -l, of een regex-afwisseling De ontsnapping werkt zelfs binnen backtick-code-overspanningen - een zeldzaam geval waarin Markdown's gebruikelijke " code-overspanningen letterlijk" regel is niet van toepassing.
De nieuwe lijn. GFM-tabellen zijn strikt één rij per regel, dus een cel kan geen echte regeleinde bevatten De universele workaround is een HTML <br> tag. Wanneer u meerregelige inhoud in het raster plakt, voegt de generator de tag voor u in; wanneer u een tabel importeert met daarin <br>, het converteert terug naar een echte regeleinde in de editor, zodat de cel comfortabel is om te bewerken.
Nog twee regels zijn de moeite waard om in het geheugen te zetten, omdat ze & quot; mijn tabel rendert" rapporten die niets met de tabel zelf te maken hebben Ten eerste heeft een tabel een lege regel nodig als deze op een paragraaf volgt Ten tweede moet binnen een lijstitem de hele tabel worden ingesprongen in het lijstitem' s inhoudskolom - anders slikt de lijst de eerste regel in en landt de scheidingstekenrij op de verkeerde plaats.
Waar tabellen vandaan komen, en hoe elk geval stroomt
Een spreadsheet die u toegestuurd kreeg
Kopieer het bereik, plak in het deelvenster Importeren, laad het in het raster, verwijder de kolommen die niemand nodig heeft, richt de numerieke kolom met de rechtermuisknop, kopieer de Markdown. Minder dan een minuut voor een tabel die er tien nodig heeft om de hand op te maken.
Een query resultaat of een API antwoord
Gegevens die beginnen zoals JSON meestal één hop nodig heeft Converteer het met JSON naar CSVplak vervolgens de CSV in de importeur Ga de andere kant op - een Markdown tabel die je nodig hebt als data - exporteer CSV vanaf de output tabs en voer het door CSV naar JSON.
Een tabel die al bestaat in een README
Plak het in het deelvenster Importeren Het komt terug in het raster met zijn uitlijningen intact, dus het toevoegen van een kolom of het opnieuw ordenen van rijen is eerder een normale bewerking dan een herschrijving Dit is de workflow die ik het meest gebruik: documentatietabellen groeien maandenlang rij voor rij, en moeten dan in één keer worden geherstructureerd.
Een vergelijkingstabel die je helemaal opnieuw schrijft
Begin met het raster, typ zoals je denkt, en laat de opvulling zichzelf uitzoeken Een vergelijking schrijven in een raster in plaats van in de pijpsyntaxis houdt je aandacht op de vraag of de vergelijking eerlijk is in plaats van op de vraag of de kolommen op één lijn liggen.
Documentatie die in meerdere renderers moet werken
Genereer de Markdown voor de platforms die GFM-tabellen ondersteunen en schakel vervolgens het uitvoertabblad over naar HTML voor het tabblad dat dat niet doet. Hetzelfde raster, twee exports, geen hertyping. Als uw pijplijn Markdown toch naar HTML converteert, Markdown naar HTML laat je precies zien wat de conversie oplevert.
Markdown-tabellen versus HTML-tabellen
| overweging | Afwaarderingstabel | HTML-tabel |
|---|---|---|
| Leesbaarheid van bron | Hoog - scanbaar als platte tekst | Laag - tags domineren de inhoud |
| Meerlijnige cellen | Alleen via <br> |
Native, elke blokinhoud |
| Samengevoegde cellen | Niet ondersteund | colspan en rowspan |
| Per-kolom uitlijning | Ja, via scheidingstekens | Ja, via CSS of attributen |
| Stylingcontrole | niet een | Volledige CSS |
| Renderer-ondersteuning | GFM-extensie, wijdverspreid maar niet universeel | Universeel waar HTML is toegestaan |
| Diff vriendelijkheid | Goed, één lijn per rij | Slecht, veel lijnen per rij |
De praktische regel: gebruik Markdown totdat je een samengevoegde cel, een blokelement binnen een cel of specifieke styling nodig hebt Schakel die ene tabel vervolgens over naar HTML en laat de rest van het document met rust. De meeste Markdown-renderers geven onbewerkte HTML door, dus het mixen van de twee in één bestand is normaal.
Een opmerking over privacy
De tabellen die mensen bouwen zijn vaak degene die ze liever niet uploaden: prijzen nog niet aangekondigd, personeelsbestand, interne benchmarks, een client' s gegevens geplakt uit een spreadsheet.
De generator is client-side JavaScript Het raster, de import parser, en elke export run in de pagina, en niets dat je plakt verlaat je machine Laad het een keer en het blijft offline werken Dat is hetzelfde principe achter alles op Toolz.dev, en de redenering is de moeite waard om volledig te lezen in de gids op Gegevensprivacy in online tools. Als u een bredere set browsergebaseerde hulpprogramma's voor dagelijks werk samenstelt, zal de Handleiding voor coderingshulpmiddelen en de Webontwikkelaar Toolkit bedek wat nog meer een bladwijzer oplevert.
Praktische tips
Houd de header kort. Met opvulling aan stelt de breedste cel in een kolom de breedte in van elke rij in de bron Een uitgebreide header maakt het onbewerkte bestand luidruchtig zonder renderingvoordeel.
Wees niet bang voor niet-opgevulde uitvoer voor gegenereerde bestanden. Als een tabel door een script wordt geschreven en nooit als bron wordt gelezen, schakelt u opvulling uit en slaat u de bytes op.
Sorteer voordat je plakt. Rijen één pijl-klik tegelijk opnieuw ordenen is prima voor vijf rijen en vervelend voor vijftig Sorteer eerst in het spreadsheet en importeer vervolgens.
Kijk voor de lege koprij. Met " eerste rij is header" uitgeschakeld, de generator zendt een lege header uit boven uw gegevens, omdat GFM geen manier heeft om een headerless tabel uit te drukken Sommige renderers laten dat zien als een dunne lege rij Als u er last van heeft, exporteert u HTML, die helemaal geen header nodig heeft.
Controleer het weergegeven resultaat, niet de bron. Gevoerde bron die er perfect uitziet, kan nog steeds verkeerd worden weergegeven als de scheidingstekenrij het verkeerde aantal cellen heeft. Plak in de preview van welk platform u ook publiceert voordat u het klaar noemt.
FAQ
Hoe maak ik een tabel in Markdown?
Een Markdown-tabel heeft een koprij nodig, een scheidingstekenrij van koppeltekens en één rij per record, met cellen gescheiden door pijptypen Vul het raster in de generator in en het gereedschap schrijft die syntaxis voor u, inclusief de scheidingstekenrij en eventuele uitlijningskleuren.
Hoe lijn ik kolommen uit in een markdown-tabel?
Uitlijning wordt ingesteld met dubbele punten in de scheidingstekenrij: een dubbele punt links wordt uitgelijnd, dubbele punten aan beide zijden in het midden en een dubbele punt rechts wordt rechts uitgelijnd Kies een uitlijning uit een kolomkop in de editor en de juiste plaatsing van de dubbele punt wordt automatisch gegenereerd.
Kan ik een Excel- of Google-bladbereik converteren naar een Markdown-tabel?
Ja. Kopieer de cellen in uw spreadsheet en plak ze in het importpaneel. Spreadsheets plaatsen door tabs gescheiden tekst op het klembord, dat de importeur automatisch detecteert en in het raster wordt geladen.
Hoe plaats ik een pijpkarakter in een tafelcel?
Een letterlijke pijp moet met een backslash worden ontsnapt of de renderer leest hem als een kolomscheider Typ de pijp normaal in de editor en de generator ontsnapt eraan in de uitvoer voor u.
Kan een Markdown Table-cel meerdere regels bevatten?
Niet bij echte nieuwe regels, omdat GFM-tabellen strikt één rij per regel zijn De gebruikelijke oplossing is een HTML-regelafbrekingstag in de cel, die deze tool automatisch invoegt wanneer een cel die u plakt een regelafbreking bevat.
Waarom wordt mijn tabel weergegeven als platte tekst op github?
De scheidingstekenrij is bijna altijd de oorzaak: het moet de tweede regel zijn en deze moet hetzelfde aantal cellen hebben als de koptekst. Een ontbrekende lege regel voordat de tabel de weergave ervan kan stoppen wanneer de tabel een alinea volgt of in een lijst staat.
Moet ik de kolommen opvullen zodat de bron op één lijn staat?
Nee. Inleveraars negeren extra spaties, dus een niet-opgevulde tabel wordt identiek weergegeven. Er bestaat opvulling voor mensen die het onbewerkte bestand in een editor of een diff lezen. Schakel het uit met de opgevulde uitgangstuimel als u de voorkeur geeft aan een compacte bron.
Worden markdown-tabellen overal ondersteund?
Tabellen zijn een GitHub Flavoured Markdown-extensie in plaats van onderdeel van de originele CommonMark-specificatie GitHub, GitLab, Obsidian, Notion, Docusaurus en de meeste statische-site-generatoren ondersteunen ze, maar sommige minimale renderers niet. Schakel de uitvoer over naar HTML als de jouwe er een van is.
