Skip to content

docs: hide contributors regenerate tip from the site - #1500

Merged
mrexox merged 3 commits into
evilmartians:masterfrom
MikevPeeren:docs/hide-contributors-curl-comment
Aug 21, 2026
Merged

mrexox merged 3 commits into
evilmartians:masterfrom
MikevPeeren:docs/hide-contributors-curl-comment

Conversation

@MikevPeeren

@MikevPeeren MikevPeeren commented Aug 20, 2026 •

Copy link
Copy Markdown
Contributor

Summary

  • The contributors page kept a curl | jq regenerate tip in an HTML comment (<!--- ... -->).
  • Lefthook’s docs site is built with docmd, which defaults to security.html: 'escape', so that comment is escaped and shown as visible text (also mangled by markdown-it’s typographer). Live example: https://lefthook.dev/misc/contributors/
  • Enabling security.html: 'allow' would fix HTML comments but can also interpret placeholders like <shell> as tags, so instead use a markdown link-definition comment ([//]: # '...') that stays in the source and does not render.

Test plan

docmd escapes HTML by default, so the old HTML comment leaked onto
lefthook.dev/misc/contributors as visible text.
@MikevPeeren
MikevPeeren requested a review from mrexox as a code owner August 20, 2026 13:30
@greptile-apps

greptile-apps Bot commented Aug 20, 2026 •

Copy link
Copy Markdown

Confidence Score: 5/5

The PR appears safe to merge.

No blocking failure remains; the regeneration command now emits raw Markdown bullets with GitHub profile URLs.

Reviews (3): Last reviewed commit: "docs: fix contributors regenerate comman..." | Re-trigger Greptile

Comment thread docs/misc/contributors.md Resolved
docmd escapes HTML by default, so <!-- ... --> leaked onto the
site. Use a markdown link-definition comment so the curl tip stays
in the source but does not render.
@MikevPeeren MikevPeeren changed the title docs: show contributors regenerate command as a code block docs: hide contributors regenerate tip from the site Aug 20, 2026
Include the markdown list marker and use html_url so regenerated
entries match the existing contributor links.
@mrexox

mrexox commented Aug 21, 2026

Copy link
Copy Markdown
Member

Oops, looks like docmd doesn't parse comments after the version update. Thank you for taking care!

@mrexox
mrexox merged commit fd88b10 into evilmartians:master Aug 21, 2026
12 checks passed
@MikevPeeren
MikevPeeren deleted the docs/hide-contributors-curl-comment branch August 21, 2026 15:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants