Markdown
Markdown is a simple way to add style, lists, links, and other formatting to plain text. In Shy Editor, you can use Markdown syntax, and it will automatically be transformed into the final view right inside the editor window. Supported elements are:
Block-Level Elements
These elements affect entire lines or paragraphs.
Headings
Use #
, ##
, ###
, or ####
followed by a space to create different levels of headings:
# Title (H1)
## Subtitle (H2)
### Heading (H3)
#### Strong Block (H4)
Resulting Output:
Title (H1)
Subtitle (H2)
Heading (H3)
Strong Block (H4)
Lists
Unordered List
Use -
or *
followed by a space:
- Item 1
- Item 2
- Sub-item 2.1
Resulting Output:
- Item 1
- Item 2
- Sub-item 2.1
Ordered List
Use numbers followed by a period:
1. First item
2. Second item
3. Third item
Resulting Output:
- First item
- Second item
- Third item
Task Lists
Use [ ]
for uncompleted tasks and [x]
for completed ones:
- [ ] Uncompleted task
- [x] Completed task
Resulting Output:
- Uncompleted task
- Completed task
Blockquotes
Use >
followed by a space:
> This is a blockquote.
Resulting Output:
This is a blockquote.
Code Blocks
Use triple backticks (```) to create a block of code:
```
def hello_world():
print("Hello, World!")
```
Resulting Output:
def hello_world():
print("Hello, World!")
Inline Formatting
These elements modify text within a sentence.
Text Styling
Italics
Wrap words in *
or _
:
*italic* or _italic_
Resulting Output: italic or italic
Bold
Wrap words in **
or __
:
**bold** or __bold__
Resulting Output: bold or bold
Bold & Italic
Wrap words in ***
or ___
:
***bold & italic*** or ___bold & italic___
Resulting Output: bold & italic or bold & italic
Strikethrough
Wrap words in ~~
:
~~strikethrough~~
Resulting Output:
strikethrough
Inline Code
Wrap words in backticks (`):
`inline code`
Resulting Output:
inline code
Horizontal Line
Use three hyphens (---
) on a new line:
---
Resulting Output: