curvenote init

curvenote init turns a folder of Markdown and notebooks into a Curvenote project. It asks a few questions about the project and writes a curvenote.yml at the root with the project’s settings and its site template. Run it in the folder that holds your content:

cd my-paper
curvenote init

When it finishes, preview the project with curvenote start. Open the folder in VS Code with the Curvenote extension and it checks curvenote.yml and your frontmatter as you edit them.

Start from somewhere else¶

• --github <url>: start from a GitHub repository used as a template.

• --curvenote <url>: start from a project in the Curvenote editor (see curvenote clone).

• --output <folder>: where to write the new project; use . for the current folder.

Authors¶

--add-authors adds authors to the project’s frontmatter. With no value it asks for them one at a time. Give it ORCID iDs to look each person up, or "Name; Affiliation; Email" for people without one; separate several with commas.

curvenote init --add-authors 0000-0002-7859-8394,0000-0002-1825-0097

Options¶

• -y, --yes: take the default answer to every question.

• --write-toc: write the table of contents into the project file, so you can edit the order of pages.

• --domain <domain>: the domain to deploy the site to, on curve.space or your own.

• --improve: answer the questions again for an existing project, to update its configuration.

• --write-template: write a template.yml with the questions init asks, to customize them.

• -f, --force: remove the build folder and install the theme again.

• --branch <branch>: the branch of the theme to download, main by default.