search

jupyter-book / mystmd

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

Tracking: GW OSPO #1340

Open rowanc1 opened 4 months ago

rowanc1 commented 4 months ago

Had a great call today with @labarba and @s2t2 on MyST and JupyterBook v2 coming soon, and am aiming to help them get started with the content as well as tracking the features that are necessary to get them over the line.

Content

@lheagy has done some work in this space for her lab group to create templates that might be useful:

https://github.com/ubcgif/template-repository-paper

That is setup to work in Curvenote as the deployment, but could also be tweaked to use GitHub pages by running myst init --gh-pages and following the directions.

To create a latex template you can use this guide: https://mystmd.org/jtex/create-a-latex-template

I would suggest using Typst (a newer, faster, pdf renderer), and will aim to get you a demo of that shortly.

Issues

@labarba or @s2t2, let me know if I have missed something, and please feel free to bug me here about sidenotes.

Pull Requests

labarba commented 3 months ago

Another issue I noticed is that the margin notes on JBv1 arrange vertically down from the line where they are inserted, whereas in MyST they arrange vertically UP from that line. This is counter-intuitive and makes it harder for authors to apply a natural layout of the page. See the "Note" here, before and after porting to MyST.

labarba commented 3 months ago

Bug: a sidebar inside an admonition doesn't work; see lesson 1 vignette; how to fix? (I could use a blockquote instead, if no fix is forthcoming.)

rowanc1 commented 2 months ago

Hi @labarba -- I think that a fix is a ways off for that bug and would suggest changing the content slightly to avoid the nesting.

labarba commented 2 months ago

What about the comment above about vertical placing of margin notes?