Code Inspections in Markdown
This topic lists all PhpStorm code inspections available in Markdown.
You can toggle specific inspections or change their severity level on the Editor | Inspections page of the IDE settingsĀ Ctrl+Alt+S.
Inspection | Description | Default Severity |
---|---|---|
Checks if table is correctly formatted. | Weak warning | |
Incorrectly numbered list item | Ordered list items are expected to have straight numeration starting from 1. The motivation behind this is that most of Markdown processors are ignoring the numbering of ordered lists. A processor will generate an | Warning |
Links should not contain spaces | To ensure consistency between different tools, file links should not contain spaces. Example:
[Some file link](some file.md)
A quick-fix replaces spaces with their url-encoded equivalent:
[Some file link](some%20file.md)
| Warning |
Outdated table of contents section | Checks if a particular table of contents section corresponds to the actual structure of the document. | Warning |
Checks if table has correct side borders. For compatibility reasons all table rows should have borders (pipe symbols) at the start and at the end. | Error | |
Reports unresolved file references in Markdown files. | Warning | |
Unresolved header reference | Reports unresolved header references in Markdown files. | Warning |
Unresolved link label | Reports unresolved link labels in Markdown files. | Warning |