Skip to content
Pages
On this page

Query blocks

View as Markdown

A fence that renders

A fenced block with the notdocs language is a query over the documents on the branch. It renders where it sits, as a board, a table, a list, a calendar or a gallery.

markdown
```notdocs
type: task
where: { status: doing }
view: board
groupBy: status
```

Keys

KeyValuesWhat it does
typea document typeOnly documents of this type
wherea map of frontmatter key to valueOnly documents whose frontmatter matches every entry
sorta frontmatter key, or -keyOrder; a leading minus sorts descending
viewtable, board, list, calendar, galleryHow the result renders; table is the default
groupBya frontmatter keyColumns of a board, or sections of a gallery
dateKeya frontmatter keyThe key a calendar places a document by; date, then due, when unset
limita numberAt most this many documents

Views

One column per value of groupBy, usually status. Moving a card writes the new value into that document's frontmatter and commits it; ⌥← and ⌥→ move the focused card without a pointer.

Where they run

The web app renders a query block in place. notdocs query '<yaml>' prints the same groups in the terminal, and the query.run operation is a tool for agents, so a board on a page and a board in an agent's context are the same answer.