Skip to main content

Markdown Reference

Evidence supports most markdown syntax. Below are some of the most common markdown features. For more details, check out Markdown Guide.

Text Paragraphs

This is a paragraph. It can be as long as you want. 

Add line breaks by leaving a blank line between paragraphs.

Text Styles

**Bold** text is wrapped in double asterisks
*Italic* text is wrapped in single asterisks
~~Strikethrough~~ text is wrapped in double tildes
`Inline code` is wrapped in backticks

Lists

- This is a unordered list
- It uses dashes
- To indicate items

1. This is an ordered list
1. It uses numbers to indicate order
1. The numbers you type don't matter, they will be automatically numbered

Headers

# H1 Header

## H2 Header

### H3 Header

#### H4 Header

##### H5 Header

###### H6 Header
[External link](https://google.com)

[Internal link](another/page/)

Images

![An online image](https://i.imgur.com/xyI27iZ.gif)

![An image stored in the project](my-image.png)

Storing Images and Static Files

Evidence looks for images in the /static folder in the root of your project. Create it if it doesn't exist.

+-- pages/
| `-- index.md
`-- static/
`-- my-image.png

Code Fences

In Evidence, most code fences execute SQL queries and display the results in a table.

This code fence will execute a SQL query and display the results:

```widget_orders
SELECT *
FROM orders
WHERE category = 'widget'
```

The exception is if you use one of the reserved language names, which will render the code in a code block.

```python
names = ["Alice", "Bob", "Charlie"]

for name in names:
print("Hello, " + name)
```

```r
names <- c("Alice", "Bob", "Charlie")

for (name in names) {
print(paste("Hello, ", name))
}
```

Tables

| Column 1 | Column 2 | Column 3 |
| -------- | -------- | -------- |
| Row 1 | Row 1 | Row 1 |
| Row 2 | Row 2 | Row 2 |

To display data in a table, use a Data Table instead.

Blockquotes

> This is a blockquote
>
> It can span multiple lines
> > And can be nested