By default, Stash uses Markdown as its markup language. You can use markdown
in the following places:
- any pull request's descriptions or comments, or
- in README files (if they have the .md file extension).
Use Control-Shift-P or Command-Shift-P to preview your markdown.
Markdown syntax
The table below contains examples of Markdown syntax. For a full list of all the Markdown syntax, consult the official documentation on John Gruber's Daring
Fireball site.
Headings
#
This is an H1
##
This is an H2
...
######
This is an H6
|
Paragraphs
Each
paragraph begins on a new line. Simply press <return>
for a new line.
For
example,
like
this.
You'll
need an empty line between a paragraph and any following markdown construct, such as an ordered or unordered list, for that to be rendered. Like this:
*
Item 1
*
Item 2
|
Character styles
*Italic
characters*
_Italic
characters_
**bold
characters**
__bold
characters__
|
Unordered list
*
Item 1
*
Item 2
*
Item 3
*
Item 3a
*
Item 3b
*
Item 3c
|
Ordered list
1.
Step 1
2.
Step 2
3.
Step 3
a.
Step 3a
b.
Step 3b
c.
Step 3c
|
List in list
1.
Step 1
2.
Step 2
3.
Step 3
*
Item 3a
*
Item 3b
*
Item 3c
|
Quotes or citations
Introducing
my quote:
>
Neque porro quisquam est qui
>
dolorem ipsum quia dolor sit amet,
>
consectetur, adipisci velit...
|
Inline code characters
Use
the backtick to refer to a `function()`.
There
is a literal ``backtick (`)`` here.
|
Code blocks