jupyter-book / mystmd

Command line tools for working with MyST Markdown.
https://mystmd.org/guide
MIT License
219 stars 64 forks source link

Update paper.md Example Frontmatter in Quickstart Guide to Avoid PDF Export Issues #1632

Open myeongseok-kwon opened 2 weeks ago

myeongseok-kwon commented 2 weeks ago

Proposal

In the Quickstart guide for MyST documents, the paper.md example shows the keywords frontmatter as a comma-separated string. However, using the keywords in this format can lead to issues when exporting to PDF.

Based on my experience, the correct format for the keywords frontmatter in the current version should be an array (e.g., keywords: [myst, markdown, open-science]) to avoid these export problems. Updating this example in the documentation would ensure a smoother experience for others working with MyST and PDF exports.

Additional notes

This small change can help new users avoid errors during the export process, especially those unfamiliar with frontmatter configurations in MyST. Thank you for considering this improvement!