MeDiVa
DocsReference

Overview

Tag-first reference for mediva's v1 syntax — every tag and the rules (props) you can put on it.

The model: open a tag that matches your content, attach props (a flag, or name=option), then close with its end tag. Pick a tag to see its props. Generated from the @example JSDoc on each definition.

TagRolePropsDescription
blockContainer21The one recursive container tag. Wraps a heading plus any prose or nested tags, and is the thing presence/body rules (required, minWords, noPlaceholder, …) target. Blocks nest, so a schema is an AST of blocks — close every one with its endblock end tag.
tableLeaf tag5A Markdown table. The template body shows one example row; the validator checks the generated output, not the example. Close with endtable.
listLeaf tag9A bullet or numbered list. Constrain it with minItems, or hold each item to a bar with each.falsifiable / each.sourced. Close with endlist.
taskListLeaf tag6A checkbox checklist of work items. Pair with allChecked or maxChecked to gate completion. Close with endtaskList.
evidenceListLeaf tag7A list of evidence or verification items — reproduction steps, manual checks, citations. Use each.falsifiable to reject vague items and each.sourced to require a resolvable citation per item. Close with endevidenceList.
choiceLeaf tag4A single- or multi-select choice expressed as checkboxes. oneChecked makes it single-select; maxChecked bounds a multi-select. Close with endchoice.
codeLeaf tag3A fenced code block. codeFenceClosed catches a fence the model left open. Close with endcode.
mediaLeaf tag1A slot for visual evidence — a screenshot or video. requiredOrNA accepts an explicit N/A for changes with nothing visual to show. Close with endmedia.
proseLeaf tag0A free-prose region with no list/table/checkbox structure — the place for narrative text that still needs minWords/maxWords/noPlaceholder. Close with endprose.
documentMarker9The document root. Wraps the whole file and is where document-scope rules (title, title.pattern, …) live. A structural marker — it takes no end<name>.
frontMarker0A frontmatter key, written front <key>. Attaches presence/value rules to a single YAML frontmatter field. A structural marker — it takes no end<name>.
structure atomsScope6Constraints on a document/block's child sections.