Wit

Known limitations

What Wit 0.3 does not do, or does with a rough edge, and the workaround. Each row was checked against the current build.

Authoring

LimitationWhat happensWorkaround
a block definition missing its name#it stays prose — #chapter and its text print as written, and a use of it is E_UNRESOLVED_REFERENCEclose every block definition
a misspelt key on a core node, @img(src: a.png, atl: A)no error; the text joins the previous value — src="a.png, atl: A" — and wit check warns W_SUSPECT_PARAMcheck keys against core vocabulary
a positional value with a commaE_TOO_MANY_ARGUMENTS — by designpass it by name
::body:: outside a definitionremoved from the textescape it: \::body::
@load inside a sentenceE_UNRESOLVED_REFERENCE for @loadgive it its own lines

Data and rendering

LimitationWhat happensWorkaround
a bare reference to a record or collectionan empty <div class="wit-node">read a field, loop, or use @table(rows: @x)
title on a, poster on videoaccepted, not emitteda definition over @node, or post-process the HTML
the HTML renderer has no options per nodeone fixed HTML shape per core namerestyle with CSS, or write a renderer
table centring comes from the theme--raw tables are not centredadd your own CSS

Tooling

LimitationWorkaround
PDF needs a system Chrome or Chromiuminstall one, or set WIT_CHROME
a table of contents has no page numbers; footnotes print as endnotesChrome's PDF can't do either; links and bookmarks stand in
no watch moderun wit build from your editor or a file watcher
source config is JSON onlyuse wit.sources.json

See also

Gotchas · Errors · Data model · Roadmap.