Skip to content

doc: remove line breaks in markdown definitions - #52490

Closed
Trott wants to merge 1 commit into
nodejs:mainfrom
Trott:doc
Closed

Trott wants to merge 1 commit into
nodejs:mainfrom
Trott:doc

Conversation

@Trott

@Trott Trott commented Apr 12, 2024

Copy link
Copy Markdown
Member

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

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
@nodejs-github-bot

Copy link
Copy Markdown
Collaborator

Review requested:

  • @nodejs/crypto

@nodejs-github-bot nodejs-github-bot added crypto Issues and PRs related to the crypto subsystem. doc Issues and PRs related to Node.js documentation. labels Apr 12, 2024
@Trott

Trott commented Apr 12, 2024

Copy link
Copy Markdown
Member Author

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....

@Trott

Trott commented Apr 12, 2024 •

Copy link
Copy Markdown
Member Author

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

@Trott

Trott commented Apr 12, 2024

Copy link
Copy Markdown
Member Author

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/

@Trott

Trott commented Apr 12, 2024

Copy link
Copy Markdown
Member Author

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.

@Trott Trott closed this Apr 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

crypto Issues and PRs related to the crypto subsystem. doc Issues and PRs related to Node.js documentation.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants