How to mark code snippet for makrdown
Asked by IT Admin:

I am wondering how one would indicate that some block of text is a code snippet for the Render-Markdown addon to format it appropriately.

I have read through the documentation thoroughly and found nothing, am I missing a basic syntax? Any advice would be helpful here.

If you are confused about the question, I am just trying to display the text as in the bottom row of this picture:

<https://streamline.atlassian.net/wiki/display/RM/Render%20Markdown?preview=/2261000/3309570/bf64ecca-da6f-4ad6-bfce-be0b9bc0aab5.png>

And wondering what I would write in the mardown macro box to display it. Really I just need to see what they wrote to show the code markdown in the example box here:

<https://streamline.atlassian.net/wiki/display/RM/Render%20Markdown?preview=/2261000/3309569/2014-10-28_091747.png>


Answers:
author: Matt Delahousaye
body: AH! OK, exactly what I needed. Any reason the three tilde delimiter is not included in the documentation? Is it something commonly used elsewhere?

comments: author: Stephen Deutsch
body: I included a cheat sheet for your reference. There is a competing standard for delimiting code blocks, but the markdown renderer in the addon does both. I didn't think about including a markdown reference in the documentation, since there are many references in other places, but it might be a good idea. I'll implement that within the next day or so.


author: Stephen Deutsch
body: Here is the original text from the image:

```
An h1 header============Paragraphs are separated by a blank line.2nd paragraph. *Italic*, **bold**, and `monospace`. Itemized listslook like:  * this one  * that one  * the other oneNote that --- not considering the asterisk --- the actual textcontent starts at 4-columns in.&gt; Block quotes are&gt; written like so.&gt;&gt; They can span multiple paragraphs,&gt; if you like.Use 3 dashes for an em-dash. Use 2 dashes for ranges (ex., "it's allin chapters 12--14"). Three dots ... will be converted to an ellipsis.Unicode is supported. ?An h2 header------------Here's a numbered list: 1. first item 2. second item 3. third itemNote again how the actual text starts at 4 columns in (4 charactersfrom the left side). Here's a code sample:    # Let me re-iterate ...    for i in 1 .. 10 { do-something(i) }As you probably guessed, indented 4 spaces. By the way, instead ofindenting the block, you can use delimited blocks, if you like:~~~define foobar() {    print "Welcome to flavor country!";}~~~(which makes copying &amp; pasting easier). You can optionally mark thedelimited block for Pandoc to syntax highlight it:~~~pythonimport time# Quick, count to ten!for i in range(10):    # (but not *too* quick)    time.sleep(0.5)    print i~~~### An h3 header ###Now a nested list: 1. First, get these ingredients:      * carrots      * celery      * lentils 2. Boil some water. 3. Dump everything in the pot and follow    this algorithm:        find wooden spoon        uncover pot        stir        cover pot        balance wooden spoon precariously on pot handle        wait 10 minutes        goto first step (or shut off burner when done)    Do not bump wooden spoon or it will fall.Notice again how text always lines up on 4-space indents (includingthat last line which continues item 3 above).Here's a link to [a website](http://foo.bar), to a [localdoc](local-doc.html), and to a [section heading in the currentdoc](#an-h2-header). Here's a footnote [^1].[^1]: Footnote text goes here.Tables can look like this:size  material      color----  ------------  ------------9     leather       brown10    hemp canvas   natural11    glass         transparentTable: Shoes, their sizes, and what they're made of(The above is the caption for the table.) Pandoc also supportsmulti-line tables:--------  -----------------------keyword   text--------  -----------------------red       Sunsets, apples, and          other red or reddish          things.green     Leaves, grass, frogs          and other things it's          not easy being.--------  -----------------------A horizontal rule follows.***Here's a definition list:apples  : Good for making applesauce.oranges  : Citrus!tomatoes  : There's no "e" in tomatoe.Again, text is indented 4 spaces. (Put a blank line between eachterm/definition pair to spread things out more.)Here's a "line block":| Line one|   Line too| Line treeand images can be specified like so:![example image](example-image.jpg "An exemplary image")Inline math equations go in like so: $\omega = d\phi / dt$. Displaymath should get its own line and be put in in double-dollarsigns:$$I = \int \rho R^{2} dV$$And note that you can backslash-escape any punctuation characterswhich you wish to be displayed literally, ex.: \`foo\`, \*bar\*, etc.
```

Probably the easiest way to delimit a code block is to surround it with three tildes (the squiggly character next to the 1 key in the upper left of the keyboard, usually) or three backticks (\`\`\`, usually the character underneath the tilde).

both on the top and on the bottom.

Here is a cheat sheet for markdown:

<https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet#code>


Tags: addon-render-markdown

cloud

confluence-cloud