Overview

Markdown Type

Output

Large Heading

# @doc #Heading

Medium Heading

# @doc ##Subheading

Small Heading

# @doc ###Subsubheading

Numbered Lists

''' @blockdoc
1. Numbered Lists
2. Numbered Lists
3. Numbered Lists
'''

Bullet Points

''' @blockdoc
* Bullet Points
* Bullet Points
* Bullet Points
'''

Images

''' @blockdoc
![Avatar](https://upload.wikimedia.org/wikipedia/commons/thumb/1/11/Test-Logo.svg/783px-Test-Logo.svg.png )
'''

Sized Images (note the additional size argument at the end of the image url)

''' @blockdoc
![bar](bar.jpg =100x100 sets size to 100px x 100px
![bar](bar.jpg =100x*) sets the height to "auto"
![baz](baz.jpg =80%x5em) Image with width of 80% and height of 5em
'''

Italic Text

# @doc *Italics*

Bold Text

# @doc **Bold**

Code Snippet

@doc `a = 2 + 3`

Section Divider

# @doc -------------

Strikethrough

# @doc ~~strikethrough~~

Underline

# @doc __underline__

Escape Underline

# @doc \__nounderline__

Table

''' @blockdoc
| h1 | h2 | h3 |
|:------|:-------:|--------:|
| 100 | [a][1] | ![b][2] |
| *foo* | **bar** | ~~baz~~ |
'''

Line Break (two spaces after the end of a line)

''' @blockdoc
Line
Next line
'''

Line Break (alt)

''' @blockdoc
Line

Next line
'''

Emoji

# @doc this is a :smile: smile emoji

Link (You must include http:://www for all links)

# @doc Here is an example [link](http://www.google.com)

Examples

Example 1: Using Markdown in a blockdoc docstring

''' @blockdoc
Here is an example [link](http://www.google.com)
#Heading  
##Subheading  
###Subsubheading  
Regular text  
1. Numbered List  
* Bullet Point  
- Other bullet point  
![Avatar](https://upload.wikimedia.org/wikipedia/commons/thumb/1/11/Test-Logo.svg/783px-Test-Logo.svg.png )  
<br>

*Italics*  
**Bold**  

`a = 2 + 3`  

-------------  
~~Strikethrough~~  
__underline__  
\__nounderline__  

| h1    |    h2   |      h3 |
|:------|:-------:|--------:|
| 100   | [a][1]  | ![b][2] |
| *foo* | **bar** | ~~baz~~ |

this is a :smile: smile emoji  
```
a = 2
b = 3
c = a + b
```
'''
637637

Did this page help you?