Markdown Syntax Guide

Markdown Syntax Guide The Allura code uses markdown syntax everywhere to allow you to create rich text markup, and extends markdown in several ways to allow for quick linking to other artifacts in your project.

Markdown was created to be easy to read, easy to write, and still readable in plain text format.

Links Reference Links Artifact Links Text Blockquotes Preformatted Text Lists Tables Headers Horizontal Rules Images Escapes More Headers Code Highlighting Includes Neighborhood Notifications Download Button Project Screenshots Thanks Links Most URLs will automatically be turned into links. To be explicit, just write it like this:

http://someurl

somebbob@example.com

Output:

http://someurl

somebbob@example.com

To use text for the link, write it:

like thisOutput:

like this

You can add a title (which shows up under the cursor):

like thisOutput:

like this

Reference Links You can also put the link URL below the current paragraph like this.

Output:

You can also put the link URL below the current paragraph like this.

Here the text “link URL” gets linked to “http://url”, and the lines showing “1: http://url” won’t show anything.

Or you can use a shortcut reference, which links the text “shortcut” to the link named “shortcut” on the next paragraph.

Or you can use a shortcut reference, which links the text “shortcut” to the link named “shortcut” on the next paragraph.

Or you can use a shortcut reference, which links the text “shortcut” to the link named “shortcut” on the next paragraph.

Artifact Links Any existing forge resource can be linked with surrounding square brackets ie [MyPage] or [#123].

Links to resources in other tools can be explicitly referenced by adding a tool identifier prefix to the link. So for instance [developerwiki:MyPage] can refer to a wiki page in a developerwiki instance. You can also link to tickets with [tickets:#123] assuming there’s a 123 ticket in a Tracker instance mounted at tickets. The same is true for forums, or any of the other tools you have installed. You can even link to tickets in a subproject with [subproject.tickets:#123].

[MyPage] [developerwiki:MyPage] [#123] [tickets:#123] No example output is available for this one because it only works on real artifacts. Try it in your project!

Text Use * or _ to emphasize things:

this is in italic and so is this

this is in bold and so is this

this is bold and italic and so is this Output:

this is in italic and so is this

this is in bold and so is this

this is bold and italic and so is this

You can strike through text using HTML like this:

this is strike through text Output:

this is strike through text

Just write paragraphs like in a text file and they will display how you would expect. A blank line separates paragraphs.

So this is a new paragraph. But any text on adjacent lines will all end up in the same paragraph. Output:

Just write paragraphs like in a text file and they will display how you would expect. A blank line separates paragraphs.

So this is a new paragraph. But any text on adjacent lines will all end up in the same paragraph.

Blockquotes Use the > character in front of a line, just like in email

Use it if you’re quoting a person, a song or whatever.

You can use italic or lists inside them also. And just like with other paragraphs, all of these lines are still part of the blockquote, even without the > character in front.

To end the blockquote, just put a blank line before the following paragraph. Output:

Use it if you’re quoting a person, a song or whatever.

You can use italic or lists inside them also. And just like with other paragraphs, all of these lines are still part of the blockquote, even without the > character in front.

To end the blockquote, just put a blank line before the following paragraph.

Preformatted Text If you want some text to show up exactly as you write it, without Markdown doing anything to it, just indent every line by at least 4 spaces (or 1 tab).

This line won't *have any markdown* formatting applied.
I can even write <b>HTML</b> and it will show up as text.
This is great for showing program source code, or HTML or even
Markdown. <b>this won't show up as HTML</b> but
exactly <i>as you see it in this text file</i>.

As a shortcut you can use backquotes to do the same thing while inside a normal pargraph. This won't be *italic* or **bold** at all. Output:

This line won’t have any markdown formatting applied. I can even write HTML and it will show up as text. This is great for showing program source code, or HTML or even Markdown. this won’t show up as HTML but exactly as you see it in this text file. As a shortcut you can use backquotes to do the same thing while inside a normal pargraph. This won’t be italic or bold at all.

Lists * an asterisk starts an unordered list * and this is another item in the list + or you can also use the + character – or the – character

To start an ordered list, write this:

1. this starts a list with numbers
2. this will show as number “2”
3. this will show as number “3.”
4. any number, +, –, or * will keep the list going.
   • just indent by 4 spaces (or tab) to make a sub-list
     1. keep indenting for more sub lists
   • here i’m back to the second level Output:

an asterisk starts an unordered list and this is another item in the list or you can also use the + character or the – character To start an ordered list, write this:

this starts a list with numbers this will show as number “2” this will show as number “3.” any number, +, –, or * will keep the list going. just indent by 4 spaces (or tab) to make a sub-list keep indenting for more sub lists here i’m back to the second level Tables You can create tables using pipes and dashes like this:

Output:

First Header Second Header Content Cell Content Cell Content Cell Content Cell

You can use markdown syntax within table cells for formatting:

Output:

First Header Second Header Content Cell Content Cell Content Cell Content Cell

You can also create tables using HTML code.

Headers Just put 1 or more dashes or equals signs (—– or ===) below the title.

This is a huge header

this is a smaller header

Output:

This is a huge header this is a smaller header Horizontal Rule Just put three or more *’s or –’s on a line:

Output:

Or, you can use single spaces between then, like this:

Output:

or

Output:

Make sure you have a blank line above the dashes, though, or else:

you will get a header

Output:

you will get a header Images To include an image, just put a “!” in front of a text link:

Output:

The “alternate text” will show up if the browser can’t load the image.

You can also use a title if you want, like this:

Output:

To reference an attached image, just use the img macro. You can add more attributes:

[[img src=attached-image.jpg alt=foobar]] Output:

Escapes What if you want to just show asterisks, not italics?

• this shows up in italics: a happy day
• this shows the asterisks: *a happy day* Output:

this shows up in italics: a happy day this shows the asterisks: a happy day The backslashes will disappear and leave the asterisks.

You can do the same with any of the characters that have a special meaning for Markdown.

HTML tags may need to be escaped. will be interpreted as a bold tag. Entity codes will be used. isn’t allowed and will be dropped, so you probably want to escape it:

:::python
# Code goes here ...