Improvements to MyST Markdown

[rowanc1]

The Econ-ARK team is working towards improvements to their tools, specifications and workflows to create reproducible, computational documents. This includes a focused effort to adopt MyST Markdown (https://mystmd.org) into the REMARK workflow. To do this, there are several identified improvements to be made in MyST, especially regarding:

• Table improvements (reading, rendering, export for LaTeX and Typst).
• Improved LaTeX support for existing projects (included subfiles, macros and common economics packages)
• Shared math macros, including via web-request
• Reproducibility checks and command line improvements to the REMARK tools.

The goal of this issue is to track these specific improvements that need to be made across that project and any documentation improvements in the REMARK repository.

LaTeX improvements [14.5 days]

Tasks here will be turned into issues and pull requests as appropriate. This issue will be kept up to date as we refine and prioritize the work.

• Math spacing for latex export 🧮 Fix math-spacing in paragraphs jupyter-book/mystmd#1032 [0.5 days]
• Parsing longtable and other tabular environments [2 days] 🍽 Improve LaTeX table parsing jupyter-book/mystmd#1041
• Simple table alignment | c |
• Better documentation of latex [0.5 days] --> myst 📖 Document writing in LaTeX jupyter-book/mystmd#1086
• Recursive includes/inputs in latex [3 days] 🔄 Support recursive includes in myst and tex jupyter-book/mystmd#1082
• Include latex snippets (tables) jupyter-book/mystmd#797
• Page break: [1 day] Page break jupyter-book/mystmd#714
• Supporting macros/frontmatter across files [1.5 days] 🧮 Frontmatter in include files removed, math/abbreviations maintained jupyter-book/mystmd#1156
• Supporting math macros information [2 days] 🧮 Give title/description to math macros jupyter-book/mystmd#1218
• Supporting extends [4 days] ✨ Add extends field to myst.yml for composing multiple yamls jupyter-book/mystmd#1215, 🌎 Fetch config extensions from URL jupyter-book/mystmd#1251
• Supporting stigma (example)
• Sharing math macros, including via web-request Separate math macros file jupyter-book/mystmd#336

Stretch Goals

• math macros (multiple arguments)
• Support latex subfiles
• Table widths are preserved to and from latex
• Extensibility and plugins for latex parsing
• Table theme improvements (e.g. alignment (e.g. decimal alignment), borders)
• Math macros work in JupyterLab
• JupyterLab citations 🧑🏻‍🔬 Citations & bibliography jupyter-book/jupyterlab-myst#161
• Ability to sort citations in References section jupyter-book/mystmd#874
• DOI link resolves with no author data and poor citekey jupyter-book/mystmd#711
• Better documentation of typst export

Remark CLI [13.5 days]

The Python management CLI is now in the main branch.

For the econark CLI, we are extending MyST to:

• Citation CFF creation [2 days] (single source of truth myst build --cff)
• Readme Creation [2 days] (rendering markdown, markdown templating, export example)
• Inherit standards [1 day] (allows for econ ark to create sharable config)
• White labelling an econark CLI [4 days] (optional, can just use myst)
• Citation CFF Test [4 days] (requires curvenote at the moment)
• Report help [0.5 days]

Examples [6 days]

• https://github.com/econ-ark/EpiExp
  • extend to computational models [1day]
• https://github.com/llorracc/SolvingMicroDSOPs [5days] (produces both paper and lecture notes)
  • 👩‍🎓 Differentiate behavior of newcommand, renewcommand, providecommand jupyter-book/mystmd#1343
  • 👩‍🎓 Add wrapfigure latex environment jupyter-book/mystmd#1342
  • Finish up work and present progress [1 day]
  • hyptertargets
  • example of subfiles (use input!)
• https://github.com/econ-ark/BufferStockTheory (and latest)
  • new theorem support
  • Conversion v1
  • Conversion v2 - https://github.com/llorracc/BufferStockTheory-Latest/issues/135

cc @alanlujan91 @llorracc