Add rule MD055/table-missing-border (fixes #93, refs #1039, no generated files).

This commit is contained in:
Gabriel Kuznik 2023-12-01 12:33:48 +01:00 committed by David Anson
parent 4a52864b39
commit a563c082a5
11 changed files with 228 additions and 12 deletions

34
doc-build/md055.md Normal file
View file

@ -0,0 +1,34 @@
This rule is triggered when a [GFM table][gfm-table] is missing a leading
or trailing pipe character `|`.
This table is missing pipes on both sides:
```markdown
| Heading | Heading |
|---------|---------
Cell | Cell |
```
To fix this, make sure there is a pipe character at the start and end of the
row:
```markdown
| Heading | Heading |
|---------|---------|
| Cell | Cell |
```
Note that text immediately below a table is treated as part of the table and
will trigger this rule:
```markdown
| Heading | Heading |
|---------|---------|
| Cell | Cell |
This text will trigger the rule
```
Rationale: Some parsers have difficulty with tables that are missing their
leading or trailing pipe characters.
[gfm-table]: https://github.github.com/gfm/#tables-extension-