Is it appropriate for distill-like articles?
I use it for a few of my projects and it's fantastic - https://llm.datasette.io for example uses MyST Markdown: https://github.com/simonw/llm/tree/main/docs
Quarto is more for publications.
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!
I’m using Sphinx/Myst/pydata theme for my blog which is a very cool combination. But Hugo seems more established.
For more complex data visuals there's D3: https://observablehq.com/@d3/gallery
Myst provides an AST-spec, but I doubt it would be easy to integrate that into Obsidian. Maybe other can shed light on it?
And why AsciiDoc in particular? It lists the inspirations for the beyond-Markdown features.
I am getting a bit tired of all the markdown flavours and extensions
What I haven't seen at a quick glance is the ability to link to any place in the document (sink) from withing the document itself (source). Maybe I did not look far enough in the examples. reStructuredTex can do this, and org-mode can do that too. And I don't mean just linking to existing headings. The other required things like footnotes and citations and so on seem to be there. Now if this reaches mainstream and we start writing documentation in it, there is great potential to have finally good documentation, not limited by the likes of github markdown. Of course same is true for reStructuredText and org-mode. From that perspective, one could ask, why yet another format was necessary, rather than improving tooling for lets say reStructuredText.
Yes, true, no good documentation has ever been written in Markdown. Good point.
You can create an anchor:
(my-anchor)=
...and then link to it: [see here](#my-anchor)
(https://mystmd.org/guide/cross-references)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)
I opted for Djot (https://djot.net) as a second-place alternative with support for many more languages. My use case was attempting a Sphinx alternative in TypeScript. (Link for the curious: https://steveasleep.com/djockey/)
> a Sphinx alternative in TypeScript.
We have some unfortunate naming that follows from history. The Python tools you're referring to are a distinct project. The Jupyter Book project saw the development of many of those tools, and is now pivotting to a new engine MyST-MD that this article links to!
Why do you say that these tools aren't complete? Whilst we are certainly not "done", these tools are being used in many places, such as https://proceedings.scipy.org/2024
Looking forward to hearing from you!
{rolename}`and here is my role's content!`
I would personally prefer something like Tex here. You just need backslashes, square brackets and braces.I guess this is inspired by Restructured Text. Not a fan of that—it looks like the most punctuation-heavy lightweight markup language.