Live data from Hacker News

Myst Markdown – Markdown for technical/scientific document

mystmd.org

41–47 of 47 posts

Re: Myst Markdown – Markdown for technical/scientific document

#41
post #4

After reading the introductory page, I don't see any benefit over Quarto, and in fact some limitations in comparison.

I'd use myst for docs, it's simpler, lighter, and interlinks well. Quarto is more for publications.

MyST-MD is also aimed at publications! See the SciPy proceedings for some examples: https://proceedings.scipy.org/2024

Re: Myst Markdown – Markdown for technical/scientific document

#42

Is there a way to write a myst markdown file for one page, a tex file for another linked page, and have them both compile to html seamlessly? I have been doing this with markdown + pandoc for my web page, and I wonder if there is something richer than plain markdown to use for my non-latex content.

mystmd supports parsing .tex files as well as MyST Markdown. There are some technical limitations here given the difficulty in parsing Markdown, but it's certainly usable.

Re: Myst Markdown – Markdown for technical/scientific document

#43

As a notorious Markdown critic, I have to say, their syntax really looks like a decent attempt of support for technical and scientific documents. Having used reStructuredText for a thesis with a lot of bells and whistles, and having used org-mode mostly ever since, I am not just admitting it willy-nilly. Then of course some of its syntax and syntax concepts are straight out of reStructuredText's book, so it makes sen…

This is a lovely comment to read, thank you.

The only implementation of restructured text is the docutils-Sphinx ecosystem. MyST Markdown was designed as a nicer language for Markdown-familiar authoring: https://executablebooks.org/en/latest/blog/2020-08-07-announ...

In the myst-md project, we're applying many of the lessons that we learned in the Jupyter Book project. One of the big takeaways is that the tooling is equally as important as the underlying markup, and docutils/Sphinx was holding us back in a few areas.

If you like links within documents, take a look at embedding (https://mystmd.org/guide/embed) and cross-referencing (https://mystmd.org/guide/cross-references)

Re: Myst Markdown – Markdown for technical/scientific document

#44
post #4

After reading the introductory page, I don't see any benefit over Quarto, and in fact some limitations in comparison.

The main _technical_ difference between the two tools is the underlying approach to how we handle ASTs. MyST-MD leverages the unified-js tooling around AST handling, whereas Quarto uses Pandoc.

For UX, we think that MyST has a lot of nice bells and whistles, but we really need to author a blog post or documentation page to clarify the user-facing differences!

Re: Myst Markdown – Markdown for technical/scientific document

#45

As a notorious Markdown critic, I have to say, their syntax really looks like a decent attempt of support for technical and scientific documents. Having used reStructuredText for a thesis with a lot of bells and whistles, and having used org-mode mostly ever since, I am not just admitting it willy-nilly. Then of course some of its syntax and syntax concepts are straight out of reStructuredText's book, so it makes sen…

One of the most powerful features that I pushed the MyST team to incorporate is xref (linking External MyST projects via borrowed syntax from ReStructuredText) https://mystmd.org/guide/external-references#myst-xref Which allows supplying a list of external references, and complete metadata: https://mystmd.org/guide/website-metadata#myst-xref-json

Re: Myst Markdown – Markdown for technical/scientific document

#46
post #32

I've really had a pet peeve about footnotes on mobile and this does the crime. If you click a footnote and it jumps very far away and doesn't have a return navigation, I have left your page usually after the second time I see a footnote and didn't note my exact scroll. A small thing but pretty please don't make me have to hunt for where I was...

Oh, it turns out we already do this! A small bugfix to make these always-visible on mobile displays :)

https://github.com/jupyter-book/myst-theme/issues/513

Re: Myst Markdown – Markdown for technical/scientific document

#47
post #32

I've really had a pet peeve about footnotes on mobile and this does the crime. If you click a footnote and it jumps very far away and doesn't have a return navigation, I have left your page usually after the second time I see a footnote and didn't note my exact scroll. A small thing but pretty please don't make me have to hunt for where I was...

Oh, it turns out we already do this! A small bugfix to make these always-visible on mobile displays :) https://github.com/jupyter-book/myst-theme/issues/513

Nice! Glad to see. Huge quality of life improvement
Post reply on HN