ISP Micropublication Template

This repo contains a template for creating Impact Scholars Program micropublications using MyST Markdown.

For a complete tutorial, read Authoring an ISP micropublication

Quick setup

If you're familiar with the tools involved, these few steps are all you need. We expect you to have a working conda/mamba setup. For guidance on this, see the Conda/Mamba Tutorial.

1. Install MyST Markdown using the provided environment file:

   mamba env create -f environment.yml
   mamba activate isp-paper

2. Edit your content in index.md

3. Add your figure (replace figure.png)

4. Update myst.yml

5. Replace the thumbnail in thumbnails/thumbnail.png for the gallery display

6. Preview locally:

   • While you're working on the paper, the best option is to run myst start
   • Before pushing, check that the static build (more detail in optional reading) is working as expected

   myst build --typst && myst build --html && npx serve _build/html

7. Update this README.md: include any information that someone reaching the repository may need. You can keep this README if you prefer, it won't be rendered.

File Structure

File	Purpose
environment.yml	Conda/mamba environment for MyST
index.md	Your paper content
myst.yml	Metadata: authors, title, keywords, DOI
bib.bib	Bibliography in BibTeX format
figure.png	Your main figure (max 6 panels)
thumbnails/thumbnail.png	Gallery thumbnail image

---

I want to know more!

We've outlined some technical details here.