Markdown Tools › Markdown linter
Markdown linter
A linter reads your text and points out things that are likely mistakes or inconsistent style. For Markdown that means structure problems that break rendering and small style issues that make a file harder to maintain.
This linter runs all the checks of the MarkdownBooks manuscript checker: unclosed code fences, skipped heading levels, repeated headings, links to missing headings, uneven tables and remote images. It adds style rules with an L code: trailing spaces, tab characters, three or more blank lines in a row, a missing space after the # of a heading, and a heading that is not followed by a blank line.
Every finding comes with a line number and a suggested fix. Style rules are advice, not errors, and a document can be perfectly valid while breaking them. Nothing is uploaded; the checks run in your browser.
How to use it
- Paste your Markdown.
- Read the findings with their line numbers.
- Fix them and run the linter again.
Worked example
Reports a missing space after # and trailing spaces.
Questions
- What do the codes mean?
- E, W and I codes match the book converter. L codes are style rules.
- Are style rules required?
- No. They are advice.
- Does it fix the file?
- No. It reports problems with suggestions.
- Is my text uploaded?
- No.
Turn your Markdown into a book