mystmd-quickstart's Introduction

MyST Quickstart

This repository contains the files used in the quickstart guide, and can be used to follow that guide, before trying MyST with your own content.

Note This is not a good example of an actual myst project! The repositories purpose is to be a simple markdown + notebook repository that can be transformed throughout a tutorial.

The goals of the quickstart guide are:

Create a myst site, using the standard template
Improve the frontmatter, to add authors, affiliations and other metadata
Export the paper as a PDF, Word document, and LaTeX files
Integrate a Jupyter Notebook output into our paper, to improve reproducibility
Publish a website of with our work 🚀

Improving Frontmatter and MyST Site

Export as a PDF

mystmd-quickstart's People

Contributors

Stargazers

Watchers

mystmd-quickstart's Issues

mystmd-quickstart requires libwebp

Describe the bug

context
When I install mystmd via conda-forge, then clone mystmd-quickstart and start myst...

expectation
I expected myst to start cleanly.

bug
But instead myst conplains about needing cwebp and gif2webp to convert images in the example site.
Here's an error message I ran into...

(myst) user@host mystmd-quickstart % myst

Welcome to the MyST Markdown CLI!! 🎉 🚀

myst init walks you through creating a myst.yml file.

You can use myst to:

 - create interactive websites from markdown and Jupyter Notebooks 📈
 - build & export professional PDFs and Word documents 📄

Learn more about this CLI and MyST Markdown at: https://mystmd.org


✅ Project already initialized with config file: myst.yml
✅ Site already initialized with config file: myst.yml

? Would you like to run myst start now? Yes
📖 Built README.md in 31 ms.
📖 Built 01-paper.md in 31 ms.
📖 Built 02-notebook.ipynb in 28 ms.
⚠️  _build/site/public/citations-01c13a8e952550bf7ad0007c7d6f1c0f.png Could not convert from image _build/site/public/citations-01c13a8e952550bf7ad0007c7d6f1c0f.png to webp:
cwebp is required

⚠️  _build/site/public/equations-dad93b54bf18b479b68ab0a8384114fe.gif Could not convert from image _build/site/public/equations-dad93b54bf18b479b68ab0a8384114fe.gif to webp:
gif2webp is required

⚠️  _build/site/public/interactive-7251e78319202f81d4bea564a130d641.gif Could not convert from image _build/site/public/interactive-7251e78319202f81d4bea564a130d641.gif to webp:
gif2webp is required

⚠️  _build/site/public/structured-data-b3aa5d9e5ffd367aba4e8a4d9da1bb6c.gif Could not convert from image _build/site/public/structured-data-b3aa5d9e5ffd367aba4e8a4d9da1bb6c.gif to webp:
gif2webp is required

⚠️  _build/site/public/pdf-two-column-79f9f7d96e3ffac6ab995c03b7853f82.png Could not convert from image _build/site/public/pdf-two-column-79f9f7d96e3ffac6ab995c03b7853f82.png to webp:
cwebp is required

⚠️  _build/site/public/frontmatter-after-826e29e74b9eb9caf83ef34262c7cd16.png Could not convert from image _build/site/public/frontmatter-after-826e29e74b9eb9caf83ef34262c7cd16.png to webp:
cwebp is required

⚠️  _build/site/public/export-pdf-609cdc89df97c7998a23e2f17d53e6f5.png Could not convert from image _build/site/public/export-pdf-609cdc89df97c7998a23e2f17d53e6f5.png to webp:
cwebp is required

⚠️  _build/site/public/citations-01c13a8e952550bf7ad0007c7d6f1c0f.png Could not convert from image _build/site/public/citations-01c13a8e952550bf7ad0007c7d6f1c0f.png to webp:
cwebp is required

📚 Built 3 pages for project in 112 ms.


	✨✨✨  Starting Book Theme  ✨✨✨



🔌 Server started on port 3000!  🥳 🎉


	👉  http://localhost:3000  👈



   ╭────────────────────────────────────────────╮
   │                                            │
   │     Update available! v1.1.50 ≫ v1.2.0     │
   │                                            │
   │   Run `pip install -U mystmd` to update.   │
   │                                            │
   │     Follow @MystMarkdown for updates!      │
   │      https://twitter.com/MystMarkdown      │
   │                                            │
   ╰────────────────────────────────────────────╯

problem
This is a problem for people becoming acquainted with myst for the first time as it implies a buggy experience.

Reproduce the bug

mamba create -n myst nodejs
mamba activate myst
mamba install mystmd
git clone https://github.com/executablebooks/mystmd-quickstart.git
cd mystmd-quickstart
myst
Y

List your environment

# Name                    Version                   Build  Channel
bzip2                     1.0.8                h93a5062_5    conda-forge
ca-certificates           2024.2.2             hf0a4a13_0    conda-forge
giflib                    5.2.2                h93a5062_0    conda-forge
icu                       73.2                 hc8870d7_0    conda-forge
lerc                      4.0.0                h9a09cb3_0    conda-forge
libcxx                    16.0.6               h4653b0c_0    conda-forge
libdeflate                1.20                 h93a5062_0    conda-forge
libexpat                  2.6.2                hebf3989_0    conda-forge
libffi                    3.4.2                h3422bc3_5    conda-forge
libjpeg-turbo             3.0.0                hb547adb_1    conda-forge
libpng                    1.6.43               h091b4b1_0    conda-forge
libsqlite                 3.45.2               h091b4b1_0    conda-forge
libtiff                   4.6.0                h07db509_3    conda-forge
libuv                     1.48.0               h93a5062_0    conda-forge
libwebp                   1.3.2                hf30222e_1    conda-forge
libwebp-base              1.3.2                h93a5062_1    conda-forge
libzlib                   1.2.13               h53f4e23_5    conda-forge
mystmd                    1.1.50             pyh80e38bb_0    conda-forge
ncurses                   6.4.20240210         h078ce10_0    conda-forge
nodejs                    20.9.0               h3b52c9b_1    conda-forge
openssl                   3.3.0                h0d3ecfb_0    conda-forge
pip                       24.0               pyhd8ed1ab_0    conda-forge
python                    3.12.2          hdf0ec26_0_cpython    conda-forge
readline                  8.2                  h92ec313_1    conda-forge
setuptools                69.2.0             pyhd8ed1ab_0    conda-forge
tk                        8.6.13               h5083fa2_1    conda-forge
tree                      2.1.1                hb547adb_0    conda-forge
tzdata                    2024a                h0c530f3_0    conda-forge
wheel                     0.43.0             pyhd8ed1ab_1    conda-forge
xz                        5.2.6                h57fd34a_0    conda-forge
zlib                      1.2.13               h53f4e23_5    conda-forge
zstd                      1.5.5                h4f39d0f_0    conda-forge