Markdown

Markdown is a markup language which you can use to add formating elements to plaintext text documents (read more here). In Teragrep, markdown is a standalone interpreter.

If you wish to use extended syntax, you can read the documentation of Markdown Guide.

To use markdown in Teragrep’s editor, write %md at the start.

Headings

Add number signs (#) in front of a word a phrase to create a heading. The heading level is defined by the number of number signs you use.

%md
# Heading level 1

## Heading level 2

### Heading level 3

#### Heading level 4

##### Heading level 5

###### Heading level 6

Headings in markdown

Alternative Syntax

You can use == or -- instead for creating a level 1 and 2 heading.

%md
Heading level 1
===============

Heading level 2
---------------

Alternative markdown headings

Best Practices

Put always a space between the number signs and the heading name, otherwise Teragrep won’t recognize it’s a heading.

%md
# Do like this

#But not like this

You should also put blank lines before and after a heading.

%md
When adding headings, remember to put blank lines before and after.

# Heading

Like this!
%md
If there are no blank lines before and after, Teragrep won't recognize that you added a heading.
# Heading
In other words, don't do this!

Paragraphs

TBA

Line Breaks

TBA

Emphasis

You can add emphasis by making text bold or italic.

%md
**This is bold text**
__This is also bold text__

*This is italic text*
_This is also italic text_

Markdown emphasis

Bold and Italic

%md
***This is bold and italic text***
___This is also bold and italic text___

__*This is an alternative italic and bold text*__
**_This is also an alternative italic and bold text_**

bold and italic

Best Practices

Teragrep don’t recognize your emphasis if you use underscores in the middle of a word. Use instead asterisks to bold, italicize or bold and italicize the middle of a word for emphasis.

%md
Don't_do_this
Don't__do__this
Don't___do___this

Blockquotes

Add > in front of a paragraph to create a blockquote.

%md
> I am a blockquote

Markdown blockquote

Blockquotes can contain multiple paragraphs as well.

%md
> I am a blockquote.
>
> And I am a paragraph inside the blockquote.

Markdown blockquote with paragraph

You can also nest blockquotes.

%md
> I am a blockquote.
>
>> I am a nested blockquote.

Nested blockquote

Blockquotes with Other Elements

You can add other markdown formatted elements inside a blockquote.

%md
> # This is a title inside a blockquote
>
> - I am a list item
> - And so I am too
>
> I am **bold** and I am *italic*

Best Practices

Put blank lines before and after a blockquote. Teragrep won’t otherwise recognize there’s a blockquote added in the text.

%md
If you don't add blank lines before and after the blockquote...
> I am a blockquote.
Teragrep won't realize there's a blockquote.

Lists

You can create ordered or unordered lists with markdown.

%md
This is ordered list

1. First item
2. Second item
3. Third item

This is unordered list

- First item
- Second item
- Third item

This is also an unordered list

* First item
* Second item
* Third item

Indented Items

Use one tab to indent the list item.

%md
This is ordered list

1. First item
    1. Indented item
    2. Indented item
2. Second item

This is unordered list

* First item
    * Indented item
    * Indented item
* Second item

Adding Elements in Lists

TBA

Best Practices

Don’t use parenthesis ) as a delimiter in ordered lists.

%md
Don't do this

1) First item
2) Second item

Don’t mix and match delimiters in the same unordered list.

%md
Don't do this

- First item
* Second item

Code

Enclose your word or phrase with backticks (`) to denote it as code.

%md
To use markdown, write `%md` at the start in the editor.

To create a code block, indent every line of the block by at least one tab or four spaces.

%md
Let's add a code block with one tab.

    <p>This is a HTML paragraph</p>

And another with four spaces.

    <b>This is bolded text.</b>

Horizontal Rules

Use three or more asterisks *, dashes --- or underscores _ on a line by themselves.

%md
***

---

________________

Put blank lines before and after horizontal rules, otherwise Teragrep won’t recognize it.

%md
This would be a heading without blank lines.
---
So don't do this!