doc: remove line breaks in markdown definitions #52490
Conversation
A line break in a definition ends the definition, causing an error with upcoming changes to the linter and possibly other tools. This (or some other change) is needed for nodejs/remark-preset-lint-node#511. Refs: nodejs/remark-preset-lint-node#511
|
Review requested:
|
nodejs-github-bot
added
crypto
|
Whoops, guess I should have run "make lint-md" with the current linter before doing this. Odd that the new linter didn't flag it, but maybe the more strict definition line-break rule was coupled with a more lenient line length rule for definitinos? Anyway....will fix.... |
|
Aw crud, the GitHub-flavored markdown spec (or whatever you want to call it) specifically says that titles can be muti-line so this seems like it might be a bug in the new remark lint plugin. It's supposed to be a link definition, so I wonder if the way we're using it (without links) is the problem. More investigating to do.... EDIT: Ref: https://github.github.com/gfm/#link-reference-definitions |
|
Oh, here we go, GFM considers these things footnotes and not link definitions, so the new plugin probably needs a bugfix. https://github.blog/changelog/2021-09-30-footnotes-now-supported-in-markdown-fields/ |
|
Looks like the plugin doesn't understand multi-line footnotes. Or at least that's what I think is going on. I'm going to close this and pursue changes in the plugin or configuration or something like that. Thanks. |
A line break in a definition ends the definition, causing an error with upcoming changes to the linter and possibly other tools.
This (or some other change) is needed for
nodejs/remark-preset-lint-node#511.
Refs: nodejs/remark-preset-lint-node#511