mdl

Fixed

• Fixed crash on startup when using old versions of the uri gem. #606

Added

• Added treat_links_as_single_word option to MD013 #580

Fixed

• MD013 - Do not trigger on a single long word in backticks #580
• MD013 - Do not trigger on a single long word alone on a line continuation #580
• MD013 - Do not trigger on a list item with a single long word #580
• Docker - Use latest alphine so mdl version is correct

Added

• Add autocorrecting #519

Changed

• Added extra documentation around excluding rules #516
• Update Kramdown #539
• Start from all rules when style only contains exclusions #551
• Give error when explicitly specified config file is not found #554
• Skip docs footer for rules without a docs URL #556
• Fix "bulletd" typo in test file names #557
• Accept string values for symbol params in style files #561
• Bump bundler version #569

Fixed

• MD005 - Fixed inconsistent UL/OL ordering #539
• MD013 - Fixed line length detection #539
• Fix fenced code blocks not detected without preceding blank line #541
• Fix front matter offset when blank line follows closing --- #542
• MD029 - Fix false positive for ordered lists inside blockquotes #543
• MD026 - Fix false positive on emoji shortcodes in headers #543
• MD011 - Fix false positive on footnote references #545
• Fix crash on files with invalid UTF-8 byte sequences #546
• MD034 - FIx not detecting bare URLs inside tables #547
• Fix front matter regex matching --- inside code blocks #548
• MD037 - Fix false positive on escaped emphasis markers #549
• MD014 - Fix false positive on code blocks with only blank lines #550
• MD040 - Fix false positive on tab-indented code blocks #552
• MD034 - Fix false positive for URLs inside HTML elements #553
• Fix double slashes in file paths when directory has trailing slash #555
• MD031 - Fix false positive on inline backtick code spans #558
• MD013 - Detect table-like lines even when kramdown parses them as paragraphs #560
• MD007 - Fix false positive on unrelated lists at different indent levels #562
• MD034 - Fix false positive when link text contains pipe character #564
• MD032 - Fix false positive on HTML comments adjacent to lists #565
• MD027 - Fix false positive on blockquotes with soft line breaks #566
• MD013 - Add :headings parameter to exclude headings from line length #563
• MD013 - Don't flag lines that are single-words #572

Changed

• Bumped minum ruby version to 3.2 #531, and associated changes

Fixed

• Fix Markdown lint version in SARIF output test #469
• Fix example for rulesets flag in configuration docs #473
• Require ruby-3.3.0 for standalone pre-commit hook #528

Rules Removed

• Removed MD055, MD056, MD057 - These rules for tables caused regressions and were removed (see #472 for details)

Rules Added

• MD055 - Tables: Each row must start and end with a | #464
• MD056 - Tables: Number of columns is the same for all rows #464
• MD057 - Tables: In the second row every column must have at least ---, possibly surrounded with alignment : chars #464

Added

• Add SARIF output #459
• Document DCO process better #448 and #449

Changed

• MD009 - Allow exactly 2 trailing spaces by default #452
• MD033 - Add allowed_elements parameter #450
• Updated build instructions #431

Fixed

• MD027 - handle anchor elements correctly #463
• Fix examples for RULES.md for MD007 #462
• Fix links to use https instead of http #447
• Make RULES.md comply with our own rules #439
• Fix docker builds #429

Rules Added

• MD047 - File should end with a blank line

Added

• New 'docs' method on rules to provide a URL and longer description
• docker_image-based pre-commit

Changed

• Changed the default for MD007 to 3 spaces to match minimum spaces for ordered lists
• Added option :ignore_code_blocks to rule MD010. If set to true, hard tabs in code blocks will be ignored.
• Added option :ignore_code_blocks to rule MD013. If set to true, hard tabs in code blocks will be ignored. The option :code_blocks has been marked as deprecated in the documentation. If :code_blocks is set to false in the configuration, a deprecation warning is printed.
• Improved documentation on custom rules and rulesets
• Handle non-printable characters gracefully
• Support configurable sublist styles for MD004

Fixed

• Fixed directory argument with --git-recurse
• Preserve empty lines at the end of a file

Fixed

• Fixed crash when using -g
• Fixed missing dependencies in docker image

Added

• More examples of mdlrc and style files
• Added CI for Rubocop and Markdownlint on our own repo

Fixed

• Update Dockerfile to work with modern mdl
• Update minimum version of kramdown for security advisory
• Update minimum version of rubocop for security advisory

Changed

• Better error messages on missing styles #302
• Use require_relative to speed up requires #297
• Bumped alpine version in the Dockerfile #155

Fixed

• Fix crash in --json #286
• Handle codeblocks that are nested #293
• Fix handling of blockquoted list items #284

Changed

• Don't ship test / example files in the gem artifact #282

Fixed

• Handle newlines on Windows better #238

Added

• Pull request and issue templates for users and contributors
• Move to kramdown 2
• Handle Kramdown TOC
• Loosen various dependencies and move minimum ruby version to 2.4

Added

• There are now CONTRIBUTING.md and MAINTAINERS.md docs
• There is now a .pre-commit-hooks.yaml for those who want to use pre-commit.com

Changed

• Ignore blank line after front matter #248
• Only import JSON when necessary #231
• Use newere mixlib-cli #265
• Nicer error message when activating nonexistent rule #246
• Fix documentation on ignore_front_matter #241
• Update docs to use "MY" prefix for custom rule example #245
• Fix crash in MD039 when the link text is empty #256
• Reference Node.js markdownlint #229
• Added table of contents to RULES.md for easier navigation #232
• Fix typos in MD046 docs #219
• Fixed MD036 crash #222

Removed

Added

• Add md042 to enforce code block style
• JSON formatter/output

Changed

• Allow different nesting on headers duplication check #200
• MD036 - Ignore multi-line emphasized paragraphs, and emphasized paragraphs that end in punctuation #140

Fixed

• Fix issue numbers false positives #168
• Lint MD039 checking for nodes inside link text #102

Added

• Ignore yaml front matter option #130 and #143

Changed

• Allow top level header rules (MD002, MD025, MD041) to be configurable #142

Fixed

• Read UTF-8 files correctly even if locale is set to C #135, #146, #147 and #148
• Fix issues loading .mdlrc file #126, #129, #133 and #148
• Fix erroneous triggering of MD022/MD023 in some cases #144
• Detect codeblock lines correctly when ignoring them #141

Fixed

• Fix error on starting mdl