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 HMpTy can be found here: http://HMpTy.readthedocs.org
Usage:
hmpty init
hmpty htmid <level> -- <ra> <dec>
hmpty [-f] index <tableName> <primaryIdCol> <raCol> <decCol> (-s <pathToSettingsFile>|--host <host> --user <user> --passwd <passwd> --dbName <dbName>)
hmpty search <tableName> <raCol> <decCol> <ra> <dec> <radius> (-s <pathToSettingsFile>|--host <host> --user <user> --passwd <passwd> --dbName <dbName>) [(-r <format>|-r mysql <resultsTable>)]
Options:
init setup the sherlock settings file for the first time
index add HTMids to database table
search perform a conesearch on a database table
htmid generate the htmID at the given coordinates for the give HTM level
tableName name of the table to add the HTMids to
primaryIdCol the name of the unique primary ID column of the database table
raCol name of the table column containing the right ascension
decCol name of the table column containing the declination
ra the right ascension of the centre of the conesearch circle or coordinate set
dec the declination of the centre of the conesearch circle or coordinate set
radius the radius of the conesearch circle (arcsec)
level the HTM level required
-f, --force force a regeneration of all HTMIDs
-h, --help show this help message
-v, --version show version
-s <pathToSettingsFile>, --settings <pathToSettingsFile> path to a settings file containing the database credentials
--host <host> database host address
--user <user> database username
--passwd <passwd> database password
--dbName <dbName> database name
-r <format>, --render <format> select a format to render your results in
If iA transclusion is working you will see a unicorn here:
/multimarkdown_transclusion_test_20190121111324.md
Linking to an Adjacent File ∞
CriticMarkup ∞
This is a test.
This is is a test.
This isn’tis 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.
Task Lists ∞
Completed task item
Unfinished task item
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
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 with title
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.