Skip to content

docs: list --version in the man page and fix --no- option spelling - #4192

Merged
UziTech merged 1 commit into
markedjs:masterfrom
Aryapatel-007:docs/man-page-version-option
Nov 9, 2026
Merged

UziTech merged 1 commit into
markedjs:masterfrom
Aryapatel-007:docs/man-page-version-option

Conversation

@Aryapatel-007

@Aryapatel-007 Aryapatel-007 commented Nov 6, 2026 •

Copy link
Copy Markdown
Contributor

Marked version: master (18.1.3)

Markdown flavor: n/a

Description

No existing issue that I could find. This fixes two errors in the CLI man page, man/marked.1.md, which marked --help shows.

Expectation

  • The OPTIONS list includes -v, --version, which bin/main.js handles and the SYNOPSIS already mentions.
  • The inverse-option entry shows a spelling the CLI accepts.

Result

  • -v, --version is missing from OPTIONS.
  • The entry reads --no-breaks, -no-etc.... In bin/main.js, a single-dash argument longer than two characters is split into single-letter flags, so -no-breaks is read as -n -o -- .... Running marked -no-breaks in.md prints nothing and writes <p>in.md</p> to a file named --.

What was attempted

Compared the man page with the argument parser in bin/main.js. The only source file changed is man/marked.1.md; the generated man/marked.1 is not committed.

I built this branch and ran it on Node 22: --version and -v both print 18.1.3, --no-breaks renders normally, and -no-breaks behaves as described above. npm run build:man also succeeds.

AI disclosure: this PR was generated by Claude Code (Claude Opus 5.5), following the repo's AGENTS.md.

Contributor

  • Test(s) exist to ensure functionality and minimize regression (if no tests added, list tests covering this PR); or,
  • no tests required for this PR.
  • If submitting new feature, it has been documented in the appropriate places.

Committer

In most cases, this should be a different person than the contributor.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@vercel

vercel Bot commented Nov 6, 2026

Copy link
Copy Markdown

@Aryapatel-007 is attempting to deploy a commit to the MarkedJS Team on Vercel.

A member of the Team first needs to authorize it.

@vercel

vercel Bot commented Nov 9, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
marked-website Ready Ready Preview Nov 9, 2026 10:41pm UTC

Request Review

@UziTech UziTech left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! 💯

@UziTech
UziTech merged commit 8ac3e20 into markedjs:master Nov 9, 2026
8 checks passed

This branch was successfully deployed

1 active deployment
Preview — 4438feea Deployed Nov 9, 2026 by vercel[bot]
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