Skip to article frontmatterSkip to article content
Site not loading correctly?

This may be due to an incorrect BASE_URL configuration. See the MyST Documentation for reference.

πŸ“ Using MyST

Previewing your MyST siteΒΆ

Building your site for the first timeΒΆ

Every MyST site must have a myst.yml config file that defines the project.

Right-click this file in the file browser and select the first item on the context menu: β€œBuild MyST Project”.

A new tab will open displaying a loading progress indicator. After a few seconds, your site will be built and you’ll it displayed in the current tab.

Subsequent buildsΒΆ

In JupyterLab, your site will not automatically rebuild when you make changes! This functionality will be available in JupyterLab the future.

For now, the JupyterLab infrastructure will magically add a β€œRebuild” button to the top-right of your site, which you can click to trigger a new build of your site.

Do this every time you make a change to see if it worked correctly!

How this worksΒΆ

This functionality is provided by the extension jupyter-myst-build-proxy.