Markdown

Markdown is a lightweight markup language that helps style your texts. You can style any part of your text as header, bold or italic. Also, you can create headers, clickable links and insert source code block with the Python syntax highlighting.

On Letpy, you can use Markdown to style your questions, posts, and replies. In fact, all text-based content on our platform is written in Markdown.

The Markdown is used widely in the computer world. For instance, GitHub (the largest provider of Internet hosting for collaborative software development), Stackoverflow (answer and question website about programming), and hundreds other great sites use it for the writing purposes.

Definitely, the Markdown is vital peace of knowledge if you want to tie you life with the programming.

Italic font

In Markdown, the text between two asterisk characters * or two underscore _ signs become italic:

Written

This is my first _italic text_ in Markdown. And this text is *italic* too.

Rendered

This is my first italic text in Markdown. And this text is italic too.

Bold font

If you are using two asterisk characters or two underscore signs on both sides of the text, rendered font becomes bold:

Written

This is my first __bold text__ and this text is **bold** too.

Rendered

This is my first bold text and this text is bold too.

Lists

You can use the * character or the - character to create unordered lists:

Written

* First;
* Second;
* Third.

Rendered

  • First;
  • Second;
  • Third.

Written

- First;
- Second;
- Third.

Rendered

  • First;
  • Second;
  • Third.

Also, lists can be numbered:

Written

1. First;
2. Second;
3. Third.

Rendered

  1. First;
  2. Second;
  3. Third.

To create a clickable link, you should use the syntax construction below:

Written

An example of the [clickable](https://letpy.io/) link.

Rendered

An example of the clickable link.

At first, you need to type the text you want to be clickable in square brackets and then the link address in the parenthesis.

Quotes

Sometimes, when you reply to somebody message, you need to quote its part or even whole message. In Markdown you can use > sign for that purpose:

Written

> How to lean Python? 

You should practice hard and don't forget about theory.

Rendered

How to lean Python?

You should practice hard and don’t forget about theory.

Source code

To call out the code within a sentence, use single backticks:

Written

This can be useful, when you mention the `variable` or `function` name.

Rendered

This can be useful, when you mention the variable or function name.

If you want to create a code block, that contains at least one line of the code, use triple backticks:

Written

```
print("Hello, world!")
```

Rendered

print("Hello, world!")

To enable syntax highlighting in the code block, you can use optional language identifier. In our case it will be python:

Written

```python
name = input("What is your name? ")
print("Hello, ", name)
```

Rendered

name = input("What is your name? ")
print("Hello, ", name)

Headers

Add characters # before word or sentence you want to become a header. The number of these characters defines the header level:

Written

# First level header
## The second one
### Third level header

Rendered

First level header

The second one

Third level header

Emoji

You can add emoji to your text by using emoji name enclosed in colons:

Written

It's my first emodji :thumbsup:

Rendered

It’s my first emodji: thumbsup:

We use GitHub emoji codes, so for a full list of available emoji and codes, see the GitHub Emoji-Cheat-Sheet.

Paragraphs

To create a new paragraph just leave a blank line between lines of text:

Written

The first paragraph text.

The second one.

Rendered

The first paragraph text.

The second one.