![](\"https://raw.githubusercontent.com/mayank1513/mayank1513/main/popper.png\")
\n\n[](https://github.com/md2docx/table/actions/workflows/test.yml) [](https://codecov.io/gh/md2docx/table) [](https://www.npmjs.com/package/@m2d/table)  \n\n> A plugin that converts Markdown tables into rich, styled Word tables with full alignment, border, and header support.\n\n---\n\n## ๐ฆ Installation\n\n```bash\nnpm install @m2d/table\n```\n\n```bash\npnpm add @m2d/table\n```\n\n```bash\nyarn add @m2d/table\n```\n\n---\n\n## ๐ Overview\n\nThe `@m2d/table` plugin for [`mdast2docx`](https://github.com/mayankchaudhari/mdast2docx) renders Markdown tables into Word-compatible tables with customizable layout, alignment, and cell styling using the `docx` library.\n\n> Automatically handles header rows, borders, shading, cell alignments, and padding โ all configurable.\n\n---\n\n## โจ Features\n\n- Transforms Markdown tables into `docx.Table` elements\n- Auto-detects column alignment from MDAST (`left`, `center`, `right`)\n- Customizable:\n - Table width and border styles\n - Cell padding and shading\n - Header row formatting\n - Horizontal and vertical alignment\n- Graceful fallback to defaults if MDAST alignment is missing\n\n---\n\n## ๐ ๏ธ Usage\n\n```ts\nimport { toDocx } from \"@m2d/core\";\nimport { tablePlugin } from \"@m2d/table\";\n\nconst plugins = [tablePlugin()];\n\nconst buffer = await toDocx(mdastTree, {\n plugins,\n});\n```\n\n---\n\n## โ๏ธ Options\n\nThe `tablePlugin` accepts an optional configuration object:\n\n```ts\ntablePlugin({\n tableProps: { ... },\n rowProps: { ... },\n cellProps: {\n ... // CellProps\n data: { bold: true, color: \"#000000\" } // Paragraph and Run styling options\n },\n firstRowProps: { ... },\n firstRowCellProps: {\n data: { bold: true, alignment: AlignmentType.CENTER } // Header cell styling\n },\n alignments: {\n defaultHorizontalAlign: AlignmentType.CENTER,\n defaultVerticalAlign: VerticalAlign.CENTER,\n preferMdData: true,\n },\n});\n```\n\nAll options override the following sensible defaults:\n\n### Default Table Style\n\n| Property | Default Value |\n| -------------------- | -------------------------------------- |\n| Table Width | `100%` (percentage) |\n| Border Style | `SINGLE`, size `1` |\n| Cell Padding | 2โ4mm margins (top/bottom/left/right) |\n| Header Row | Bold with shaded background `#b79c2f` |\n| Cell Styling | Full docx.js paragraph & run options |\n| Vertical Alignment | `CENTER` |\n| Horizontal Alignment | Based on Markdown or `CENTER` fallback |\n\n### Advanced Cell Styling with `data` Property\n\nThe `data` property provides comprehensive styling control using **docx.js** paragraph and text run options:\n\n#### Text Run Styling (`IRunOptions`)\n\n- `bold`, `italics`, `underline`, `strike`, `doubleStrike`\n- `color`, `size` (font size in half-points)\n- `font` (font family), `highlight`, `shading`\n- `superScript`, `subScript`, `smallCaps`, `allCaps`\n\n#### Paragraph Styling (`IParagraphOptions`)\n\n- `alignment` - text alignment (LEFT, CENTER, RIGHT, JUSTIFIED)\n- `spacing` - line spacing and paragraph spacing\n- `indent` - left, right, first line, hanging indents\n- `numbering`, `bullet`, `style`\n\n#### Code Block Support\n\n- `pre: true` - preserves spaces, newline for code blocks\n\n```ts\ntablePlugin({\n cellProps: {\n data: {\n font: \"Arial\",\n size: 20, // 10pt font\n color: \"#333333\",\n spacing: { after: 120 }, // 6pt spacing after\n },\n },\n firstRowCellProps: {\n data: {\n bold: true,\n alignment: AlignmentType.CENTER,\n color: \"#ffffff\",\n size: 24, // 12pt font\n font: \"Calibri\",\n },\n },\n});\n```\n\n---\n\n## ๐งช Example\n\n### Markdown Input\n\n```md\n| Name | Age | City |\n| :---: | :-: | --------: |\n| Alice | 24 | New York |\n| Bob | 30 | San Diego |\n```\n\n### Output DOCX\n\n- The first row is treated as a **header**, with custom shading.\n- Column alignment is preserved: center, center, right.\n\n---\n\n## ๐ Internals\n\n- Leverages `docx.Table`, `docx.TableRow`, `docx.TableCell`, and `docx.Paragraph`\n- Dynamically maps Markdown alignment via `MDAST.align[]`\n- Uses `@m2d/core`โs block plugin API\n- Prevents re-processing of transformed nodes by setting `node.type = \"\"`\n\n---\n\n## โ ๏ธ Limitations\n\n- Does not support row/column spans\n- MDAST source must conform to [GFM tables](https://github.github.com/gfm/#tables-extension-)\n- Table styling is fixed to plugin options; no per-cell customization via Markdown yet\n\n---\n\n## โญ Support Us\n\nIf you find this useful:\n\n- โญ Star [mdast2docx](https://github.com/tiny-md/mdast2docx) on GitHub\n- โค๏ธ Consider [sponsoring](https://github.com/sponsors/mayank1513)\n\n---\n\n## ๐งพ License\n\nMIT ยฉ [Mayank Chaudhari](https://github.com/mayankchaudhari)\n\n---\n\nMade with ๐ by Mayank Kumar Chaudhari
\n","readmeFilename":"README.md"}