content.lead.mask
Require the first line of a section, or the document's first heading or paragraph, to match a mask.
Docking computer: Wrong port shape. No seal. Try again.
Quick reference
| Written as | Fails with | Applies to |
|---|---|---|
content. fix: opt-in | lead-mismatch errorvalue-wrong-form errorvalue-not-given errorvalue-not-allowed errorunknown-entity error | section |
content. fix: opt-in | first-line-mismatch errorvalue-wrong-form errorvalue-not-given errorvalue-not-allowed errorunknown-entity error | document |
Examples
content. lead. mask
Require the section's first prose line (the first paragraph under the heading, skipping fences/tables/lists) to match a mask. For the document's first line (its first heading or paragraph), use content.firstLine.mask on the document directive.
A section opening with a request line passes
<!-- mdv: section required content.lead.mask="<word|oneOf: [GET,POST,PATCH,DELETE]> <text>" -->
### Create Envelope### Create Envelope
POST /v1/envelopes✓ passes
A section opening with prose instead is flagged
<!-- mdv: section required content.lead.mask="<word|oneOf: [GET,POST,PATCH,DELETE]> <text>" -->
### Create Envelope### Create Envelope
This call makes a new envelope.
POST /v1/envelopes✗ value-not-allowed error · line 3
A commit subject on the document line passes
<!-- mdv: document content.firstLine.mask="<word|oneOf: [feat,fix,docs]>: <text>" -->feat: tune orbital beacon✓ passes
A subject without a type prefix is flagged
<!-- mdv: document content.firstLine.mask="<word|oneOf: [feat,fix,docs]>: <text>" -->tune orbital beacon✗ value-not-given error · line 1
content. firstLine. mask
Require the document's subject — its first heading or paragraph, AST-selected — to match a mask. Leading HTML is skipped; a heading is read without its # markers; a document opening with a list, table, code block, or nothing recognizable stays silent.
<!-- mdv: document content.firstLine.mask="<word|oneOf: [feat,fix,docs]>: <text>" -->
feat: tune orbital beacon