curvenote start

curvenote start builds the project and serves it as a website at http://localhost:3000. Leave it running while you write: when you save a page, it rebuilds that page and the browser reloads.

curvenote start

The site renders in the theme set by your site template, which start downloads the first time. Pair it with the Curvenote extension for VS Code, which catches mistakes in your MyST before they reach the preview. Pages with a cn:articles listing show a placeholder until they are deployed.

Notebooks

  • --execute: run the Jupyter Notebooks in the project and show their outputs.

  • --execute-parallel <n>: how many notebooks run at once, 3 by default.

Server

  • --port <port>: the port of the website (or set PORT).

  • --server-port <port>: the port of the content server the theme reads from (or set SERVER_PORT).

  • --headless: start only the content server, for a theme you run yourself.

  • --keep-host: keep your HOST environment variable instead of using localhost.

  • --template <path>: use this template instead of the one in your project file, for this run only.

  • --max-size-webp <MB>: the largest image converted to WebP, 1.5 MB by default.

When the site looks right, export it with curvenote build or publish it with curvenote deploy.

Abbreviations
MyST
Markedly Structured Text