Skip to content
Documentation

Custom Fields

updated

Custom fields put structured data on your documents — a status, an owner, a version. Define them once per project; by default every document shares them, or limit a field to some Document Types.

Add a field

Project Admins open the project’s Overview → Custom fields → Add field.

Setting What it does
Label The name on documents; unique in the project. The field’s frontmatter key is derived from it.
Description What to write in the field — shown on documents and read by AI assistants.
Type Text, Number, Yes / No, Tags or Select.
Default value What a document shows until it sets its own value.
Applies to All documents, or only some document types.
Hide when empty Leaves the field off documents with no value.

A field’s type and key can’t be changed once it exists — create a new field instead. Renaming a select option updates every document that uses it; deleting a field deletes its values.

On a document

Fields sit above the content and save as you edit. An inherited default carries a Default badge; setting your own value stops following it, and Reset to default brings it back. Values for fields outside the document’s type are kept under Not in this type.

Field values are shown on public pages when the document is public.

In the CLI and MCP

Values sync through the fields: block in frontmatter — see Frontmatter Parameters. Inherited defaults are not written into pulled files. AI assistants manage fields through the tools in MCP Tools Reference.

What’s next?

Document Types — Group documents that share fields.