# MDEx Multiline Cells
An [MDEx](https://hexdocs.pm/mdex) plugin enabling multi-line cells in Markdown tables with full inline/block Markdown rendering and automatic key-column continuation guessing.
` paragraph blocks.
- `:html_br` - Renders line breaks as raw `
` HTML inline nodes.
---
## Installation
Add `mdex_multiline_cells` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[
{:mdex_multiline_cells, "~> 0.1"},
{:mdex, "~> 0.13"}
]
end
```
---
## Usage
### 1. Automatic Continuation via Empty Key Column
```elixir
markdown = """
| # | Issue | Location | Suggested Fix |
|----|-----------------------------------|--------------------------|-----------------------------------------------------|
| B1 | Synchronous DB writes in hot path | orchestrator.ex:890, 425 | Wrap StepMetrics.record_metric in Task.start |
| | | | or use a GenServer/Agent collector that batches |
| | | | writes. At minimum, use Task.Supervisor.start_child |
| | | | with a dedicated supervisor. |
| B2 | toggle_debug_panel latch bug — | blah.ex:100 | Change to assign(:debug_log_enabled?, new_panel) or |
| | debug_log_enabled? never resets | | introduce a separate debug_panel_ever_opened? flag. |
| | to false after first open | | |
"""
html = MDEx.to_html!(markdown, plugins: [MdexMultilineCells])
```
### 2. Explicit Line Continuation (`\`) & `
` Tags
```elixir
markdown = """
| Feature | Details | Status |
| :--- | :--- | :---: |
| **Multi-line Cells** | Line 1 of description \\
Line 2 of description with `code` | Active |
| **Rich Formatting** | **Bold Line 1**
[Elixir Docs](https://elixir-lang.org) | Done |
"""
html = MDEx.to_html!(markdown, plugins: [MdexMultilineCells])
```
### 3. Via `MDEx.new/1`
Attach the plugin when initializing an `MDEx.Document`:
```elixir
MDEx.new(markdown: markdown, plugins: [MdexMultilineCells])
|> MDEx.to_html!()
```
### 4. Direct Attachment
```elixir
MDEx.new(markdown: markdown)
|> MdexMultilineCells.attach(render_as: :paragraph)
|> MDEx.to_html!()
```
---
## Configuration & Plugin Options
Options can be passed as a keyword list when attaching the plugin:
```elixir
MDEx.to_html!(markdown, plugins: [{MdexMultilineCells, render_as: :paragraph, guess_multiline: true}])
```
| Option | Type | Default | Description |
| :--- | :--- | :--- | :--- |
| `:guess_multiline` | `boolean()` | `true` | Infers multi-line cell continuations when a row's key column is empty. |
| `:key_column` | `non_neg_integer()` | `0` | 0-indexed position of the key column used for multi-line continuation guessing. |
| `:render_as` | `:line_break` \| `:paragraph` \| `:html_br` | `:line_break` | Controls how multi-line cell line segments render in HTML/AST output. |
| `:continuation_syntax` | `:all` \| `:backslash` \| `:unclosed` | `:all` | Specifies which multi-line syntax to process in table source. |
| `:strip_indentation` | `boolean()` | `true` | Whether to strip leading indentation on continuation lines. |
---
## Generated HTML Output Examples
### Default (`render_as: :line_break`)
```html
| # | Issue | Location | Suggested Fix |
|---|---|---|---|
| B1 | Synchronous DB writes in hot path | orchestrator.ex:890, 425 | Wrap StepMetrics.record_metric in Task.start or use a GenServer/Agent collector that batches writes. At minimum, use Task.Supervisor.start_child with a dedicated supervisor. |
Item |
Description |
|---|---|
Task 1 |
Line 1 of description Line 2 of description |