FIX: Markdown linter throws false positives if definitions are only used inside admonition blocks

[oesteban]

What we see in the context of #1750 seems to respond to remarkjs/remark-lint#307.

This bugfix adds the dependency (as suggested in the issue) and adds one canary to ensure it is working.

cc/ @Remi-Gau

[oesteban]

Converting to draft because this doesn't seem to work. And it seems the common-principles.md file is not linted?

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 87.93%. Comparing base (dbcb237) to head (1bc2fc4).

Additional details and impacted files

@@           Coverage Diff           @@
##           master    #1760   +/-   ##
=======================================
  Coverage   87.93%   87.93%           
=======================================
  Files          16       16           
  Lines        1351     1351           
=======================================
  Hits         1188     1188           
  Misses        163      163           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[Remi-Gau]

not sure if it helps but I had to tweak some remark linting rules when I introduced admonitions:

bids-specification/.remarkrc

Line 13 in dbcb237

["remark-lint-code-block-style", false],

[oesteban]

not sure if it helps but I had to tweak some remark linting rules when I introduced admonitions:

bids-specification/.remarkrc

Line 13 in dbcb237

["remark-lint-code-block-style", false],

Thanks for the suggestion. A naive addition of the plugin did not work (cd9c926)

[oesteban]

Defining the links inside the admonition at hand does the trick. Closing as not needed.