Skip to content

Instantly share code, notes, and snippets.

@gnn

gnn/tests.rst

Last active January 13, 2021 09:45
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save gnn/8863352b04f2bbc231218f90236cdb36 to your computer and use it in GitHub Desktop.
Save gnn/8863352b04f2bbc231218f90236cdb36 to your computer and use it in GitHub Desktop.
Download ZIP
Try out various reStructuredText features and whether and how they are rendered on GitHub
Raw
tests.rst

Math

Here's a math block. Let's see how it's rendered.

$$\sum_{n=1}^{\infty}$$

Apparently not at all. So what about the same thing inlined: $\sum_{n=1}^{\infty}$? Well, I guess at least the role is recognized and doesn't appear in the output, which is a plus.

Code

Lets see how inline code like variable = constant + 1 is rendered, especially compared to variable = constant + 1.

Also, here's a block declaring a new inline role which you shouldn't see in the rendered version:

But now Python code like dictionary = {"key": [first, "second", "{}rd".format(3)]} should be highlighted properly, but apparently it's not.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment