[DOC] MyST cheat sheet documentation #637
Conversation
|
Table information to include in cheat sheet can be found under #644. |
|
@choldgraf what's a better option for aligning a For this example, I have a long list of |
|
ah that is a tricky one - right now I don't know of a way to do this reliably (e.g. what if the content height changes?). You could add a custom class to it and use a CSS rule? Though for this one I'd just not worry about perfectly lining up the margin content... |
There was a problem hiding this comment.
This is looking really awesome! Really nice work!
One other general thought is that we should try to think of ways to cross-reference this page and other pages in the site so that users land on the page. Doesn't need to be a blocker on this PR though 👍
I have a few comments in there, and then I'm +1 on merging and iterating on the content as new ideas come to mind.
|
hmmm looks like you may have some rebase weirdness in the PR now...the only files that should be changed should be the one you added, the |
|
Yeah I noticed that too. I merged the master and then the rebase introduced the other commits. I'll fix it. |
|
Under math -- I don't see a an example of the syntax for labeled Math blocks? (https://github.com/executablebooks/MyST-Parser/blob/master/tests/test_renderers/fixtures/syntax_elements.md) (That gives you labels in html and rendered equations in jupyter) |
|
Thanks @phaustin! I'll make sure to include it under math. |
add link info add table info add admonitions add figure and image info add math add code information add block break info add how to ref docs add html block info add example of doc ref with different text add glue feature how to glue math block rearrange content misc edits + add more info links added remove ref role path to doc as it is unnecessary change location of cheatsheet.md from content to reference fix doc references add link to references.bib rename table columns "text" and "token" to "syntax" replace download directory with link test filter option under bibliography directive remove bibliography directive from myst cheatsheet add example of math block with label & misc edits
|
@choldgraf I've squashed all the commits and rebased so this branch is ready to be merged. |
|
amazing! what a complete and helpful resource, thanks so much @najuzilu ✨ |
This PR adds a new document containing a MyST syntax cheat sheet discussed in issue #628.
The following content has/will been added
This PR implements one option for displaying the content. The order in which the items are displayed is not final.
Any feedback would be greatly appreciated.