Syntax for Docs - REMOVE FROM LIVE DOCS ∞

This is a template document giving an overview of the syntax that can be used throughout these docs.

Table of Contents

AutoStructify ∞

Embed reStructuredText ∞

Todo

nice!

Code URL Resolver ∞

I can link to my setup.py file on github

Code and Syntax Highlighting ∞

Inline code has back-ticks around it.

var s = "JavaScript syntax highlighting";
alert(s);

s = "Python syntax highlighting"
print s
myString = """Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum."""

No language indicated, so no syntax highlighting. 
But let's throw in a <b>tag</b>.

Mermaid ∞

gantt
        dateFormat  YYYY-MM-DD
        title Adding GANTT diagram functionality to mermaid
        section A section
        Completed task            :done,    des1, 2014-01-06,2014-01-08
        Active task               :active,  des2, 2014-01-09, 3d
        Future task               :         des3, after des2, 5d
        Future task2               :         des4, after des3, 5d
        section Critical tasks
        Completed task in the critical line :crit, done, 2014-01-06,24h
        Implement parser and jison          :crit, done, after des1, 2d
        Create tests for parser             :crit, active, 3d
        Future task in critical line        :crit, 5d
        Create tests for renderer           :2d
        Add to mermaid                      :1d

Flowchart ∞

s=>start: start
e=>end: end
o=>operation: operation
sr=>subroutine: subroutine
c=>condition: condition
i=>inputoutput: inputoutput
p=>parallel: parallel

s->o->c
c(yes)->i->e
c(no)->p
p(path1, bottom)->sr(right)->o
p(path2, top)->o

Tables ∞

Colons can be used to align columns.

Tables	Are	Cool
col 3 is	right-aligned	$1600
col 2 is	centered	$12
zebra stripes	are neat	$1

Definitions ∞

term: definition

Transclusion ∞

If MMD transclusion is working you will see usage instructions here:

    Documentation for panstamps can be found here: http://panstamps.readthedocs.org

    Usage:
        panstamps [options] [--width=<arcminWidth>] [--filters=<filterSet>] [--settings=<pathToSettingsFile>] [--downloadFolder=<path>] (warp|stack) <ra> <dec> [<mjdStart> <mjdEnd>]
        panstamps [options] --closest=<beforeAfter> [--width=<arcminWidth>] [--filters=<filterSet>] [--settings=<pathToSettingsFile>] [--downloadFolder=<path>] <ra> <dec> <mjd>

        -h, --help                              show this help message
        -f, --fits                              download fits (default on)
        -F, --nofits                            don't download fits (default off)
        -j, --jpeg                              download jepg (default off)
        -J, --nojpeg                            don't download jepg (default on)
        -c, --color                             download color jepg (default off)
        -C, --nocolor                           don't download color jepg (default on)
        -a, --annotate                          annotate jpeg (default true)
        -A, --noannotate                        don't annotate jpeg (default false)
        -t, --transient                         add a small red circle at transient location (default false)
        -T, --notransient                       don't add a small red circle at transient location (default true)
        -g, --greyscale                         convert jpeg to greyscale (default false)
        -G, --nogreyscale                       don't convert jpeg to greyscale (default true)
        -i, --invert                            invert jpeg colors (default false)
        -I, --noinvert                          don't invert jpeg colors (default true)
        --width=<arcminWidth>                   width of image in arcsec (default 1)
        --filters=<filterSet>                   filter set to download and use for color image (default gri)
        --downloadFolder=<path>                 path to the download folder, relative or absolute (folder created where command is run if not set)
        --settings=<pathToSettingsFile>         the settings file    
        --closest=<beforeAfter>                 return the warp closest in time to the given mjd. If you want to set a strict time window then pass in a positive or negative time in sec (before | after | secs)

        ra                                      right-ascension in sexagesimal or decimal degrees
        dec                                     declination in sexagesimal or decimal degrees
        mjdStart                                the start of the time-window within which to select images
        mjdEnd                                  the end of the time-window within which to select images
        mjd                                     report the warp closest in time to this mjd
        warp                                    select the warp images to download from STScI (IP of the machine running panstamps must be white=listed by MAST to allow for warp access)
        stack                                   select the stack images to download from STScI 

If iA transclusion is working you will see a unicorn here:

/multimarkdown_transclusion_test_20190121111324.md

Linking to an Adjacent File ∞

Here is another file in the same directory

Math ∞

A formula, ${e}^{i\pi }+1=0$, inside a paragraph.

\[{e}^{i\pi }+1=0\]

Super/Sub Scripts ∞

m²

x^2,y

x_z

C₆H₁₂O₆

Citations ∞

Cite a source.[p. 42]¹

Black (2015)²

CriticMarkup ∞

This is a test.

This is is a test.

This ~~isn’t~~is a test.

This is a test.

This is a test.What is it a test of?

Paragraphs ∞

Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.

Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo. Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut odit aut fugit, sed quia consequuntur magni dolores eos qui ratione voluptatem sequi nesciunt. Neque porro quisquam est, qui dolorem ipsum quia dolor sit amet, consectetur, adipisci velit, sed quia non numquam eius modi tempora incidunt ut labore et dolore magnam aliquam quaerat voluptatem. Ut enim ad minima veniam, quis nostrum exercitationem ullam corporis suscipit laboriosam, nisi ut aliquid ex ea commodi consequatur? Quis autem vel eum iure reprehenderit qui in ea voluptate velit esse quam nihil molestiae consequatur, vel illum qui dolorem eum fugiat quo voluptas nulla pariatur?

At vero eos et accusamus et iusto odio dignissimos ducimus qui blanditiis praesentium voluptatum deleniti atque corrupti quos dolores et quas molestias excepturi sint occaecati cupiditate non provident, similique sunt in culpa qui officia deserunt mollitia animi, id est laborum et dolorum fuga. Et harum quidem rerum facilis est et expedita distinctio. Nam libero tempore, cum soluta nobis est eligendi optio cumque nihil impedit quo minus id quod maxime placeat facere possimus, omnis voluptas assumenda est, omnis dolor repellendus. Temporibus autem quibusdam et aut officiis debitis aut rerum necessitatibus saepe eveniet ut et voluptates repudiandae sint et molestiae non recusandae. Itaque earum rerum hic tenetur a sapiente delectus, ut aut reiciendis voluptatibus maiores alias consequatur aut perferendis doloribus asperiores repellat.

Cross References ∞

Intro ∞

Some text

Conclusion [fin] ∞

Link to [Intro].

Link to the [end][fin].

Link to Task Lists

Task Lists ∞

Completed task item
Unfinished task item

Footnote ∞

Here’s a sentence with a footnote³ in the middle of it!

Headers ∞

# H1
## H2
### H3
#### H4
##### H5
###### H6

Emphasis ∞

Emphasis, aka italics, with asterisks or underscores. Strong emphasis, aka bold, with asterisks or underscores. Strikethrough uses two tildes. ~~Scratch this.~~

Add highlight uses two equals highlight

Lists ∞

First ordered list item
Another item
- Unordered sub-list.
Actual numbers don’t matter, just that it’s a number
1. Ordered sub-list
And another item.

You can have properly indented paragraphs within list items.

and unordered lists:

Unordered list can use asterisks
Or minuses
Or pluses

Links ∞

I’m an inline-style link

I’m an inline-style link with title

I’m a reference-style link

I’m a relative reference to a repository file

You can use numbers for reference-style link definitions

Or leave it empty and use the link text itself.

URLs and URLs in angle brackets will automatically get turned into links. http://www.example.com or http://www.example.com and sometimes example.com (but not on Github, for example).

Some text to show that the reference links can follow later.

Images ∞

Here’s our logo (hover to see the title text):

Inline-style: alt text

Reference-style: alt text

Blockquotes ∞

Blockquotes are very handy in email to emulate reply text. This line is part of the same quote.

Quote break.

This is a very long line that will still be quoted properly when it wraps. Oh boy let’s keep writing to make sure this is long enough to actually wrap for everyone. Oh, you can putMarkdown into a blockquote.

Inline HTML ∞

You can also use raw HTML in your Markdown, and it’ll mostly work pretty well.

Definition list: Is something people use sometimes.
Markdown in HTML: Does *not* work **very** well. Use HTML tags.

Abbreviations ∞

The HTML specification is maintained by the W3C.

Horizontal Rule ∞

Three or more…

Hyphens

John Doe. A Totally Fake Book. Vanity Press, 2006. ↩
A Bryden Black 2015, The Lion, the Dove, & the Lamb, Wipf and Stock Publishers ↩
This is the footnote. ↩