title

Rules on the document's title: present, in the right form, not a placeholder, specific enough.

Docking computer: Wrong port shape. No seal. Try again.

Quick reference

Examples

title

Require the document to have a title — the PR or issue title, supplied via --title or --context.

A document with no title is flagged

contract.mdv.md
<!-- mdv: document title -->
document.md
Sensors are due for calibration before the next burn.

✗ missing-title error

title.pattern

Require the title to match a regular expression — e.g. a Conventional-Commit-shaped title.

A conventional-commit title passes

contract.mdv.md
<!-- mdv: document title title.pattern=/^(feat|fix|docs): .+/ -->
## Summary
document.md
## Summary

Relay window moved to 04:10 to clear the dust front.

✓ passes

A title without a type prefix is flagged

contract.mdv.md
<!-- mdv: document title title.pattern=/^(feat|fix|docs): .+/ -->
## Summary
document.md
## Summary

Relay window moved to 04:10 to clear the dust front.

✗ value-not-given error

title.none=@placeholders

Reject placeholder titles such as "Untitled" or "TODO".

A placeholder title is flagged

contract.mdv.md
<!-- mdv: document title title.none=@placeholders -->
## Summary
document.md
## Summary

Relay window moved to 04:10 to clear the dust front.

✗ title-placeholder error · line 1

title.words.min

Require the title to have at least N words, so it's specific rather than a single noun.

A one-word title is flagged

contract.mdv.md
<!-- mdv: document title title.words.min=3 -->
## Summary
document.md
## Summary

Relay window moved to 04:10 to clear the dust front.

✗ title-too-short warn · line 1

On this page