DOC: Add MyST syntax cheatsheet and comparison sheet
See original GitHub issueIs your feature request related to a problem? Please describe.
Add a user friendly cheatsheet for writing MyST
syntax.
It would be great if the cheat sheet could be accompanied by an “example” link in which
the same contents are displayed in rst
, MyST
, latex
(and other possible source markup types)
Currently most details for MyST
are located in the myst-parser docs but it would be nice to have a concise summary for users at the jupyter-book
level as a single stop resource.
@najuzilu would you be willing to take a project like this on?
Issue Analytics
- State:
- Created 3 years ago
- Reactions:4
- Comments:8 (8 by maintainers)
Top Results From Across the Web
MyST syntax cheat sheet - Jupyter Book
To add a label to your table simply include a :name: parameter followed by the label of your table. In order to add...
Read more >Core Syntax - MyST-Parser - Read the Docs
MyST is a strict superset of the CommonMark syntax specification. It adds features focussed on scientific and technical documentation authoring, ...
Read more >7. MyST Markdown cheatsheet - FAIR Cookbook
In order to reference a table you must add a label to it. To add a label to your table simply include a...
Read more >Markdown syntax Cheat sheet - YouTube
This is a cheat sheet video for markdown syntax files. You might have seen these files as readme.md or example.md files on github...
Read more >MyST Markdown overview — Data Science Study
MyST supports all syntax of CommonMark Markdown (the kind of Markdown that Jupyter notebooks use), as well as an extended syntax that is...
Read more >Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start FreeTop Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found
Top GitHub Comments
Thanks for the list @najuzilu . It looks great to me. Others will add more over time.
The target users @thomassargent30 and I had in mind when we suggested a cheat sheet are people getting started with Jupyter Book. The syntax most helpful to such people would be MyST / MyST-NB. For example, code blocks should be
Rather than
The aim is to help people write books in JB easily, not be a pure resource on MyST — that’s better off left to the MyST documentation.
In terms of where we put this, I don’t mind.
Perhaps a good starting point is to make something similar to https://docutils.sourceforge.io/docs/user/rst/quickref.html (but hopefully looking nicer 😃
I’m a +1 on two cheat sheets - one for common and useful syntax in MyST, and another for a full comparison (which I’d see as more of an advanced feature…we don’t want to put rST or Latex in front of new users IMO)