Skip to article content

There are currently two templates for MyST websites, a book-theme, which is the default and is based loosely on JupyterBook and an article-theme that is designed for scientific documents with supporting notebooks. The documentation for this site is using the book-theme, for a demonstration of the article-theme, you can see an article on finite volume.

Article Theme
Book Theme
Example of a banner in a site using the article-theme, (online, source)

Example of a banner in a site using the article-theme, (online, source)

Changing Site Templates

To change your website template from the default (book-theme), use the site: template: property:

  template: article-theme

Change the template property to article-theme.

Article Theme

The article theme is centered around a single document with supporting content, which is how many scientific articles are structured today: a narrative article with associated computational notebooks to reproduce a figure, document data-cleaning steps, or provide interactive visualization. These are listed as “supporting documents” in this theme and can be pulled in as normal with your Table of Contents. For information on how to import your figures into your article, see Embed and Reuse Jupyter Outputs.

The frontmatter that is displayed at the top of the article is the contents of your project, including a project thumbnail and banner. The affiliations for your authors, their ORCID, email, etc. are available by clicking directly on the author name.

Site Options

There are a number of common options between the site templates. These should be placed in the site.options in your myst.yml.

    favicon: my-favicon.ico
    logo: my-site-logo.svg

Table 1:Site Options

favicona file - Local path to favicon image
logoa file - Local path to logo image
logo_darka file - Local path to logo image to be used in dark mode only
logo_texta string - Short text to display next to logo at the top of all pages
analytics_googlea string - Google analytics key, see Adding Analytics to your MyST Website
analytics_plausiblea string - Plausible analytics key, see Adding Analytics to your MyST Website
MyST MarkdownMyST Markdown
Community-driven tools for the future of technical communication and publication