Frontmatter and myst.yml

The Curvenote extension works in the frontmatter at the top of a page and in your project’s myst.yml or curvenote.yml, the same settings the CLI reads when it builds and publishes.

Keys and values¶

The keys suggested fit where the cursor is, each with a one-line summary: a page’s keys at the top, a person’s keys inside an authors item, a license’s content and code.

After key:, the extension suggests values where there is a known set: SPDX licenses with the common ones first, true and false, a key’s choices, and the ids of the people and affiliations in the same file.

Frontmatter keeps your theme’s YAML colors. Hover a key for its documentation, or a value for what it reads as. Whether a picked key is written as a single value or opens its fields is a setting.

ORCID and ROR, checked against their records¶

Each author’s ORCID iD and each affiliation’s ROR ID is looked up in the public ORCID and ROR APIs:

• an iD or ID with no record is an error;

• a name, city or country that isn’t the record’s is a warning, and a name comes with a quick fix that writes the record’s;

• hovering an iD shows the record: the person’s name and affiliations, or the organization’s type, location, founding year and website.

A lookup that fails, because you are offline say, shows nothing rather than a false error. Turn the lookups off with curvenote.frontmatter.checkRecords in Settings. The authors you add with curvenote init --add-authors are checked the same way once they are in the file, and a venue’s checks often look at the same fields.