📖✨:hand markdown-it the anchor and footnote plugins - #1792
Open
DerekNonGeneric wants to merge 1 commit into
Open
📖✨:hand markdown-it the anchor and footnote plugins#1792DerekNonGeneric wants to merge 1 commit into
DerekNonGeneric wants to merge 1 commit into
Conversation
Both have sat in dependencies without ever reaching the markdown library — eleventy.config.mjs never touched it — so the syntax they exist to support has been rendered by whatever markdown-it does in their absence. For footnotes that is not nothing, it is wrong. A reference like `[^2]` with a matching `[^2]:` definition is perfectly good link reference syntax, so the security page has been rendering automated dependency management.<a href="https://www.mend.io/…">^2</a> printing the marker into the sentence as link text instead of a superscript pointing at a footnotes section. Headings had no ids at all, which leaves in-page links with nothing to find. Nothing published relies on one yet, but the agent forwarding draft links to `#when-show-signature-says-no-signature` twice and asks for `toc: true`, so it would have shipped broken. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
✅ Deploy Preview for gh-pages-openinf ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
markdown-it-anchorandmarkdown-it-footnotehave both sat indevDependencieswithout ever reaching the markdown library — eleventy.config.mjs never touched it. So the syntax they exist to support has been rendered by whatever markdown-it does in their absence.Footnotes were not merely absent, they were wrong
[^2]with a matching[^2]:definition is also perfectly good link reference syntax, so markdown-it happily rendered it as one. The published security page currently emits:— the marker printed into the sentence as link text, rather than a superscript pointing at a footnotes section. After:
Headings had no ids
Which leaves any in-page link with nothing to find. Nothing published depends on one yet — but agent-forwarding.md links to
#when-show-signature-says-no-signaturetwice and setstoc: true, so it would have shipped broken. It isdraft: true, so this is latent rather than live. Verified the target now resolves in a drafts build.Verification
<h2 id="issue-tracker">,<h3 id="resolving-open-issues">, …)nps build,nps test,nps format.allall passDeliberately not included
You asked me to look at what else could be wired up rather than deleted. Two findings, neither belonging in this PR:
The retext prose-linting pipeline has never run. Not the two unused plugins — the whole thing.
remark-lintrules fire correctly, but nothing innaturalLanguagedoes:retext-repeated-wordsdoes not flaghas has,retext-simplifydoes not flagutilize. The plugins are passed as module namespace objects rather than functions, so the bridge never attaches — silently, with no error. Forcing it surfaces the real failure:Unwrapping
.defaultacross the pipeline makes it work — and then reports 3,215 messages on existing content:retext-spellretext-readabilityretext-simplifyretext-repeated-wordsretext-equalityretext-profanitiesretext-passiveThat is its own project, and worth deciding on first:
retext-spellaccounts for 94% of it while duplicating cspell, which already runs and passes. Likely it should go and the rest be turned on.The remaining unwired packages are genuinely inert here, so no deletions in this PR:
remark-github,remark-html,remark-heading-id,remark-hint, andremark-directiveall transform or render markdown, but remark is only ever run as a linter (remark -f) whose output is discarded — wiring them would change nothing visible.remark-lint-code-block-styleandremark-lint-definition-spacingare already applied viaremark-preset-lint-markdown-style-guide@^4.0.0, so declaring them directly is redundant rather than useful.markdown-it-abbr,-sub,-sup, and-task-listshave no content using their syntax (the docs write<abbr>by hand).Part of #254.
List of any relevant issue numbers: #254