h.MarkupDocumentation · 1.0.0

Component reference — 1.0.0

Generated from the compiler schema. These are accepted property names, not a promise that every property affects every renderer. Layout properties apply where the component has a corresponding CSS box; drawing components use SVG coordinates. See syntax and supported behavior for rendering contracts.

Use @Name(properties): for indented blocks and @Name(properties)[content] for inline content. Positional arguments bind in the listed order; other properties are named. @P aliases @Paragraph.

Shared properties

Every registered component accepts these common properties. Use typed lengths for dimensions, quoted strings for text, symbolic values for enums, and booleans for switches. Unknown names are errors.

above, align, alt, aspectRatio, background, basis, below, beside, border, borderColor, borderWidth, bottom, breakAfter, breakBefore, case, class, color, columns, decoration, direction, family, fill, gap, grow, height, hidden, hyphens, id, indent, inset, justify, keepTogether, keepWithNext, label, lang, left, lineHeight, margin, marginBottom, marginLeft, marginOf, marginRight, marginTop, master, maxHeight, maxWidth, minHeight, minWidth, opacity, order, orphans, overflow, padding, paddingBottom, paddingLeft, paddingRight, paddingTop, page, position, radius, readingOrder, right, role, rotation, scale, shrink, size, style, textAlign, title, top, tracking, transform, weight, widows, width, x, y, z

Composition rules

Inline marks and rich text labels accept phrasing content. Put paragraphs, lists, tables, and diagrams in @Panel, @Aside, or another block container. Raw code, mathematics, and expressions retain their own syntax. In notes mode @Box: becomes a block panel; {{phrase}} and @Box[phrase] are inline boxes. @Calc is inline by default; display math is block content. Structural table/diagram children must use their corresponding component families.

Configuration

Component Content kind Positional properties Additional properties
@MarkupVersion Block / directive version version
@DocumentType Block / directive mode mode
@Metadata Block / directive — author, authors, date, description, identifier, keywords, language, rights, subject
@Use Block / directive module, names module, names
@Alias Block / directive target, name name, target
@Def Block / directive name name
@Theme Block / directive name name
@Profile Block / directive name name
@When Block / directive condition condition
@Override Block / directive target areas, rows, target
@Font Block / directive name bold, boldItalic, display, fallback, italic, name, regular, source
@TextStyle Block / directive name name
@ParagraphStyle Block / directive name name
@CharacterStyle Block / directive name name
@Page Block / directive — bleed, marks, orientation, startAt, trim
@Width Block / directive value value
@Height Block / directive value value
@Margin Block / directive value value
@Include Block / directive source source
@Asset Inline source source
@Value Inline value value
@Content Inline name name
@Let Block / directive name, value name, value

Structure

Component Content kind Positional properties Additional properties
@Document Block / directive — —
@FrontMatter Block / directive — —
@Main Block / directive — —
@BackMatter Block / directive — —
@Part Block / directive — numbered
@Chapter Block / directive — numbered
@Section Block / directive — —
@Article Block / directive — —
@Aside Block / directive title —
@Navigation Block / directive — —
@Header Block / directive — —
@Footer Block / directive — —

Text

Component Content kind Positional properties Additional properties
@Paragraph Block / directive — —
@Headline Block / directive title level, numbered
@Span Inline — —
@Emphasis Inline — —
@Strong Inline — —
@SmallCaps Inline — —
@Quote Inline — —
@BlockQuote Block / directive — attribution
@Code Inline — —
@CodeBlock Block / directive language highlight, language, numbered, startAt
@Preformatted Block / directive — —
@Link Inline href href, target
@LineBreak Inline — —
@NonBreaking Inline — —
@DropCap Inline — —
@Ruby Inline annotation annotation
@Highlight Inline message message
Component Content kind Positional properties Additional properties
@List Block / directive — marker, ordered, start
@ListItem Block / directive — term, value
@DescriptionList Block / directive — —
@TableOfContents Block / directive — depth
@ListOfFigures Block / directive — —
@ListOfTables Block / directive — —
@Index Block / directive — —
@IndexEntry Inline term term
@Glossary Block / directive — —
@GlossaryTerm Inline term definition, term

References

Component Content kind Positional properties Additional properties
@Anchor Inline name name
@Reference Inline target format, target
@PageReference Inline target target
@Footnote Inline — —
@Endnote Inline — —
@MarginNote Block / directive — —
@Citation Inline key key, locator, prefix, suffix
@Bibliography Block / directive — data, source

Pages

Component Content kind Positional properties Additional properties
@PageMaster Block / directive name bleed, name
@PageSequence Block / directive name name, startAt
@PageBreak Block / directive — —
@ColumnBreak Block / directive — —
@PageNumber Inline — StartAt, format, startAt
@PageCount Inline — —
@RunningContent Block / directive name name
@CropMarks Block / directive — —
@RegistrationMarks Block / directive — —

Layout

Component Content kind Positional properties Additional properties
@Block Block / directive — —
@Inline Inline — —
@Stack Block / directive axis, count axis, count, wrap
@Row Block / directive — wrap
@Column Block / directive — —
@Columns Block / directive count balance, count, flow, rule
@Spacer Inline — —
@Divider Block / directive — —
@Wrap Block / directive — —
@Scroll Block / directive — —
@Grid Block / directive — areas, autoColumns, autoFlow, autoRows, rows
@Area Block / directive name column, columnSpan, name, row, rowSpan
@Frame Block / directive name flow, name
@Flow Block / directive name name
@FlowInto Block / directive name name
@Float Block / directive — side
@ShapeOutside Block / directive — shape, side
@Constraints Block / directive — —
@Align Block / directive — axis, edge, offset, target, with, withEdge
@Attach Block / directive — axis, edge, offset, target, to, toEdge
@Distribute Block / directive — axis
@Guide Block / directive name name

Drawing

Component Content kind Positional properties Additional properties
@Canvas Block / directive — viewBox
@Layer Block / directive name name
@Group Block / directive — viewBox
@Rectangle Block / directive — rx, ry, stroke, strokeWidth
@Ellipse Block / directive — cx, cy, rx, ry, stroke, strokeWidth
@Line Block / directive — points, stroke, strokeWidth, x1, x2, y1, y2
@Path Block / directive — closed, d, points, stroke, strokeWidth
@Polygon Block / directive — points, stroke, strokeWidth
@TextOnPath Block / directive — offset, path
@Clip Block / directive — shape
@Mask Block / directive source shape, source
@Transform Block / directive — skew, translate
@Blend Block / directive — mode

Images

Component Content kind Positional properties Additional properties
@Image Block / directive source fit, focalPoint, source
@Picture Block / directive source fit, source, sources
@Figure Block / directive — numbered
@Caption Block / directive — —
@Gallery Block / directive — count

Data

Component Content kind Positional properties Additional properties
@Table Block / directive — data, headers, numbered, source
@TableHead Block / directive — —
@TableBody Block / directive — —
@TableFoot Block / directive — —
@RowGroup Block / directive — —
@TableRow Block / directive — —
@Cell Block / directive — columnSpan, header, rowSpan, scope
@DataSource Block / directive name data, name, source
@Repeat Block / directive items as, items

Science

Component Content kind Positional properties Additional properties
@Math Block / directive value display, value
@Equation Block / directive value numbered, value
@EquationGroup Block / directive — —
@Chemistry Block / directive value display, value
@ChemicalStructure Block / directive smiles smiles, source
@Unit Inline unit to, unit, value
@Quantity Inline value, unit to, uncertainty, unit, value
@Algorithm Block / directive — numbered
@Theorem Block / directive — numbered
@Proof Block / directive — endMark
@Definition Block / directive — numbered

Graphics

Component Content kind Positional properties Additional properties
@Chart Block / directive — data, labels, palette, type, values, xKey, yKey
@Axis Block / directive — axis, max, min, ticks
@Legend Block / directive — items
@Diagram Block / directive — —
@Node Block / directive name name
@Edge Block / directive from, to directed, from, to
@Timeline Block / directive — data
@Map Block / directive — data, projection

Media

Component Content kind Positional properties Additional properties
@Audio Block / directive source controls, source, transcript
@Video Block / directive source captions, controls, loop, muted, poster, source, transcript
@Model3D Block / directive source animationName, autoRotate, cameraControls, cameraOrbit, cameraTarget, exposure, poster, shadowIntensity, source
@ModelAnnotation Block / directive — name, normal, point
@Interactive Block / directive — kind, open
@Fallback Block / directive — —
@Download Block / directive source name, source

Forms

Component Content kind Positional properties Additional properties
@Form Block / directive — name
@Field Block / directive — max, min, name, placeholder, required, step, type, value
@Checkbox Block / directive — checked, name, required
@Choice Block / directive — multiple, name, options, value
@Button Inline — action, target, value

Authoring

Component Content kind Positional properties Additional properties
@Comment Block / directive — —
@Todo Block / directive message message
@Placeholder Block / directive message message
@DebugBox Block / directive — —
@SourceLocation Block / directive — —

Notes

Component Content kind Positional properties Additional properties
@Notes Block / directive — mode
@NoteStyle Block / directive roles roles
@Shorthand Block / directive name, expansion expansion, name
@Underline Inline message message
@Circle Inline message message
@Box Inline message message
@Strike Inline message message
@Bracket Inline message message
@Annotate Block / directive target connector, placement, target
@Connect Block / directive from, to from, kind, to
@Calc Inline value display, value
@Derivation Block / directive — reveal
@Steps Block / directive — reveal
@Step Block / directive value, reason reason, value
@Relations Block / directive value value
@Important Block / directive title —
@Question Block / directive title —
@Example Block / directive title —
@Compare Block / directive title —
@Side Block / directive title —
@ProsCons Block / directive title —
@Pro Block / directive — —
@Con Block / directive — —
@CauseEffect Block / directive title —
@Cause Block / directive — —
@Effect Block / directive — —
@Answer Block / directive — —
@Scratch Block / directive title status
@Alternative Block / directive title —
@Uncertain Block / directive title —
@Recall Block / directive prompt open, prompt
@Cloze Inline hint hint
@Panel Block / directive title —
@Tip Block / directive title —
@Warning Block / directive title —
@Summary Block / directive title —
@Fold Block / directive title open
@Task Block / directive — checked
Hamen Markup 1.0.0 · MIT license · Support