Curvenote for VS Code
The Curvenote extension for VS Code is an editor that knows MyST Markdown: it suggests directives, roles, options and frontmatter as you type, shows their documentation on hover, checks your pages as you write, looks up your authors’ ORCID and ROR records, and formats on save. The same language tools run Curvenote’s web editor, so a page reads the same in both. It works alongside the Curvenote CLI: write in VS Code, preview with curvenote start.
Figure 1:The options of the image directive, each with its documentation, suggested as you type.
Install¶
Search for Curvenote in the Extensions view of VS Code (or of Cursor, VSCodium and other editors that use Open VSX) and select Install. It is published on the Visual Studio Marketplace and Open VSX, and each release is also a .vsix file in the extension’s GitHub releases. To install from the command line:
code --install-extension curvenote.curvenote-vscodeThe extension starts when you open a .md or .myst file, or a folder with a myst.yml or curvenote.yml in it. It opens .md files as MyST; Settings shows how to keep them as plain Markdown.
What it does¶
Directives, roles and their options, written out with the cursor where you type next.
myst.ymlKeys and values for where the cursor is, with ORCID iDs and ROR IDs checked against their records.
Messages on the exact key or value they are about, many with a fix, plus highlighting, folding and formatting.
Turn the lookups and formatting hints off, choose how frontmatter is written, and pick which files open as MyST.
Issues and releases¶
Report a bug or ask for a feature in curvenote
- ID
- Identifier
- MyST
- Markedly Structured Text
- ORCID
- Open Researcher and Contributor ID
- ROR
- Research Organization Registry