Last active
August 29, 2015 14:25
-
-
Save drhirsch/d6e9f267af1194bc5b7f to your computer and use it in GitHub Desktop.
RST ReStructured Text Cheatsheet of frequently used syntax
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
hyperlink: Here is `my website <https://scivision.co>`_ | |
code: two ways to do this: | |
easy way: just indent each line of code with a tab, leaving one blank line above and below each line of code | |
better way with syntax highlighting: | |
here is my python code | |
.. code:: python | |
import numpy as np | |
np.sqrt(2) | |
print('wow') | |
titles/heading: use consistent overline & underline or just underline with the same characters e.g. ~~~~~ or ---- or ==== | |
Note that you must have these overline and underline equal to or greater length than the text you're making into a title | |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment