question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

DOC: Add MyST syntax cheatsheet and comparison sheet

See original GitHub issue

Is 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:closed
  • Created 3 years ago
  • Reactions:4
  • Comments:8 (8 by maintainers)

github_iconTop GitHub Comments

2reactions
jstaccommented, May 26, 2020

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

 ```{code-cell} ipython3
 xyz
 ```

Rather than

 ```{code-block} python
 xyz
 ```

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 😃

1reaction
choldgrafcommented, May 26, 2020

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)

Read more comments on GitHub >

github_iconTop 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 >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found