`.\nSee\n[*§ 4.9.1 The `table` element*][html-table],\n[*§ 4.9.5 The `tbody` element*][html-tbody],\n[*§ 4.9.9 The `td` element*][html-td],\n[*§ 4.9.10 The `th` element*][html-th],\n[*§ 4.9.6 The `thead` element*][html-thead], and\n[*§ 4.9.8 The `tr` element*][html-tr]\nin the HTML spec for more info.\n\nIf the alignment of a column is left, right, or center, a deprecated\n`align` attribute is added to each `| ` and ` | ` element belonging to\nthat column.\nThat attribute is interpreted by browsers as if a CSS `text-align` property\nwas included, with its value set to that same keyword.\n\n## CSS\n\nThe following CSS is needed to make tables look a bit like GitHub.\nFor the complete actual CSS see\n[`sindresorhus/github-markdown-css`][github-markdown-css]\n\n```css\n/* Light theme. */\n:root {\n --color-canvas-default: #ffffff;\n --color-canvas-subtle: #f6f8fa;\n --color-border-default: #d0d7de;\n --color-border-muted: hsla(210, 18%, 87%, 1);\n}\n\n/* Dark theme. */\n@media (prefers-color-scheme: dark) {\n :root {\n --color-canvas-default: #0d1117;\n --color-canvas-subtle: #161b22;\n --color-border-default: #30363d;\n --color-border-muted: #21262d;\n }\n}\n\ntable {\n border-spacing: 0;\n border-collapse: collapse;\n display: block;\n margin-top: 0;\n margin-bottom: 16px;\n width: max-content;\n max-width: 100%;\n overflow: auto;\n}\n\ntr {\n background-color: var(--color-canvas-default);\n border-top: 1px solid var(--color-border-muted);\n}\n\ntr:nth-child(2n) {\n background-color: var(--color-canvas-subtle);\n}\n\ntd,\nth {\n padding: 6px 13px;\n border: 1px solid var(--color-border-default);\n}\n\nth {\n font-weight: 600;\n}\n\ntable img {\n background-color: transparent;\n}\n```\n\n## Syntax\n\nTables form with the following BNF:\n\n```abnf\ngfmTable ::= gfmTableHead 0*(eol gfmTableBodyRow)\n\n; Restriction: both rows must have the same number of cells.\ngfmTableHead ::= gfmTableRow eol gfmTableDelimiterRow\n\ngfmTableRow ::= [\"|\"] gfmTableCell 0*(\"|\" gfmTableCell) [\"|\"] *spaceOrTab\ngfmTableCell ::= *spaceOrTab gfmTableText *spaceOrTab\ngfmTableText ::= 0*(line - \"\\\\\" - \"|\" / \"\\\\\" [\"\\\\\" / \"|\"])\n\ngfmTableDelimiterRow ::= [\"|\"] gfmTableDelimiterCell 0*(\"|\" gfmTableDelimiterCell) [\"|\"] *spaceOrTab\ngfmTableDelimiterCell ::= *spaceOrTab gfmTableDelimiterValue *spaceOrTab\ngfmTableDelimiterValue ::= [\":\"] 1*\"-\" [\":\"]\n```\n\nAs this construct occurs in flow, like all flow constructs, it must be\nfollowed by an eol (line ending) or eof (end of file).\n\nThe above grammar shows that basically anything can be a cell or a row.\nThe main thing that makes something a row, is that it occurs directly before\nor after a delimiter row, or after another row.\n\nIt is not required for a table to have a body: it can end right after the\ndelimiter row.\n\nEach column can be marked with an alignment.\nThe alignment marker is a colon (`:`) used before and/or after delimiter row\nfiller.\nTo illustrate:\n\n```markdown\n| none | left | right | center |\n| ---- | :--- | ----: | :----: |\n```\n\nThe number of cells in the delimiter row, is the number of columns of the\ntable.\nOnly the head row is required to have the same number of cells.\nBody rows are not required to have a certain number of cells.\nFor body rows that have less cells than the number of columns of the table,\nempty cells are injected.\nWhen a row has more cells than the number of columns of the table, the\nsuperfluous cells are dropped.\nTo illustrate:\n\n```markdown\n| a | b |\n| - | - |\n| c |\n| d | e | f |\n```\n\nYields:\n\n```html\n\n\n\n| a | \nb | \n \n\n\n\n| c | \n | \n \n\n| d | \ne | \n \n\n \n```\n\nEach cell’s text is interpreted as the [text][micromark-content-type] content\ntype.\nThat means that it can include constructs such as attention (emphasis, strong).\n\nThe grammar for cells prohibits the use of `|` in them.\nTo use pipes in cells, encode them as a character reference or character\nescape: `|` (or `|`, `|`, `|`, `|`) or\n`\\|`.\n\nEscapes will typically work, but they are not supported in\ncode (text) (and the math (text) extension).\nTo work around this, GitHub came up with a rather weird “trick”.\nWhen inside a table cell *and* inside code, escaped pipes *are* decoded.\nTo illustrate:\n\n```markdown\n| Name | Character |\n| - | - |\n| Left curly brace | `{` |\n| Pipe | `\\|` |\n| Right curly brace | `}` |\n```\n\nYields:\n\n```html\n\n\n\n| Name | \nCharacter | \n \n\n\n\n| Left curly brace | \n{ | \n \n\n| Pipe | \n| | \n \n\n| Right curly brace | \n} | \n \n\n \n```\n\n> 👉 **Note**: no other character can be escaped like this.\n> Escaping pipes in code does not work when not inside a table, either.\n\n## Types\n\nThis package is fully typed with [TypeScript][].\nIt exports no additional types.\n\n## Compatibility\n\nProjects maintained by the unified collective are compatible with maintained\nversions of Node.js.\n\nWhen we cut a new major release, we drop support for unmaintained versions of\nNode.\nThis means we try to keep the current release line,\n`micromark-extension-gfm-table@^2`, compatible with Node.js 16.\n\nThis package works with `micromark` version `3` and later.\n\n## Security\n\nThis package is safe.\n\n## Related\n\n* [`micromark-extension-gfm`][micromark-extension-gfm]\n — support all of GFM\n* [`mdast-util-gfm-table`][mdast-util-gfm-table]\n — support all of GFM in mdast\n* [`mdast-util-gfm`][mdast-util-gfm]\n — support all of GFM in mdast\n* [`remark-gfm`][remark-gfm]\n — support all of GFM in remark\n\n## Contribute\n\nSee [`contributing.md` in `micromark/.github`][contributing] for ways to get\nstarted.\nSee [`support.md`][support] for ways to get help.\n\nThis project has a [code of conduct][coc].\nBy interacting with this repository, organization, or community you agree to\nabide by its terms.\n\n## License\n\n[MIT][license] © [Titus Wormer][author]\n\n\n\n[build-badge]: https://github.com/micromark/micromark-extension-gfm-table/workflows/main/badge.svg\n\n[build]: https://github.com/micromark/micromark-extension-gfm-table/actions\n\n[coverage-badge]: https://img.shields.io/codecov/c/github/micromark/micromark-extension-gfm-table.svg\n\n[coverage]: https://codecov.io/github/micromark/micromark-extension-gfm-table\n\n[downloads-badge]: https://img.shields.io/npm/dm/micromark-extension-gfm-table.svg\n\n[downloads]: https://www.npmjs.com/package/micromark-extension-gfm-table\n\n[size-badge]: https://img.shields.io/badge/dynamic/json?label=minzipped%20size&query=$.size.compressedSize&url=https://deno.bundlejs.com/?q=micromark-extension-gfm-table\n\n[size]: https://bundlejs.com/?q=micromark-extension-gfm-table\n\n[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg\n\n[backers-badge]: https://opencollective.com/unified/backers/badge.svg\n\n[collective]: https://opencollective.com/unified\n\n[chat-badge]: https://img.shields.io/badge/chat-discussions-success.svg\n\n[chat]: https://github.com/micromark/micromark/discussions\n\n[npm]: https://docs.npmjs.com/cli/install\n\n[esmsh]: https://esm.sh\n\n[license]: license\n\n[author]: https://wooorm.com\n\n[contributing]: https://github.com/micromark/.github/blob/main/contributing.md\n\n[support]: https://github.com/micromark/.github/blob/main/support.md\n\n[coc]: https://github.com/micromark/.github/blob/main/code-of-conduct.md\n\n[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c\n\n[typescript]: https://www.typescriptlang.org\n\n[development]: https://nodejs.org/api/packages.html#packages_resolving_user_conditions\n\n[micromark]: https://github.com/micromark/micromark\n\n[micromark-extension]: https://github.com/micromark/micromark#syntaxextension\n\n[micromark-html-extension]: https://github.com/micromark/micromark#htmlextension\n\n[micromark-content-type]: https://github.com/micromark/micromark#content-types\n\n[micromark-extension-gfm]: https://github.com/micromark/micromark-extension-gfm\n\n[mdast-util-gfm]: https://github.com/syntax-tree/mdast-util-gfm\n\n[mdast-util-gfm-table]: https://github.com/syntax-tree/mdast-util-gfm-table\n\n[remark-gfm]: https://github.com/remarkjs/remark-gfm\n\n[tables]: https://github.github.com/gfm/#tables-extension-\n\n[html-table]: https://html.spec.whatwg.org/multipage/tables.html#the-table-element\n\n[html-tbody]: https://html.spec.whatwg.org/multipage/tables.html#the-tbody-element\n\n[html-thead]: https://html.spec.whatwg.org/multipage/tables.html#the-thead-element\n\n[html-tr]: https://html.spec.whatwg.org/multipage/tables.html#the-tr-element\n\n[html-td]: https://html.spec.whatwg.org/multipage/tables.html#the-td-element\n\n[html-th]: https://html.spec.whatwg.org/multipage/tables.html#the-th-element\n\n[github-markdown-css]: https://github.com/sindresorhus/github-markdown-css\n\n[api-gfm-table]: #gfmtable\n\n[api-gfm-table-html]: #gfmtablehtml\n","readmeFilename":"readme.md"} |