How to use

Detailed guides from basic operations to advanced features.

How to write Markdown

You can create team knowledge notes in Repsona (Markdown-compatible) to organize and share information. This article explains how to write Markdown.

Who can use itAvailable on
AllAll

What Is Markdown?

Markdown is a simple text-based markup language that lets you write using plain text while easily adding formatting such as bold, italics, and headings.

Because it’s just plain text, you can start writing immediately—no complex formatting or software required. It lets you focus on the essence of “writing,” without getting distracted by adjusting layouts or figuring out how an app works.

In fact, this help site itself is written in Markdown.

Features of Markdown

  • Easy for anyone to write
  • Readable as plain text
  • Simple syntax for clean formatting and structure
  • Supported by many platforms and services
  • Since it’s plain text, changes and differences are easy to track

How to write Markdown

Heading

Use # for the heading. Increasing the number of # will result in a deeper hierarchy of headings.

# Heading h1
## Heading h2
### Heading h3
#### Heading h4
##### Heading h5
###### Heading h6

Heading h1

Heading h2

Heading h3

Heading h4

Heading h5
Heading h6

Bold

Enclose it in ** to make it bold.

** Emphasis (bold) **
Emphasis (bold)

Italic

Enclose it in * to make it italic.

*Emphasis (italic)*
Emphasis (italic)

Strikethrough

If you enclose it in ~~, it will be a strikethrough.

~~strikethrough~~
strikethrough

Links can be written as [link string] (URL).

[Repsona website](https://repsona.com)
Repsona website

List

Use - for the list. You can start a new line and make a list continuously. You can move down the hierarchy with tabs.

- List
- List
    - List
  • List
  • List
    • List

Numbered list

Use 1. for numbered lists. You can start a new line and make a list continuously. You can move down the hierarchy with tabs.

1. List
1. List
    1. List
  1. List
  2. List
    1. List

Checklist

Use [ ] for the checklist. To check it, use [x].

 [ ] Checklist
 [x] Checklist
Checklist
Checklist

Table

Write the table by enclosing it like a table using | or -.

| Left align       |       Right align |    Center align    |
|:-----------------|------------------:|:------------------:|
| This             |              This |        This        |
| column           |            column |       column       |
| will             |              will |        will        |
| be               |                be |         be         |
| left             |             right |       center       |
| aligned          |           aligned |      aligned       |
Left alignRight alignCenter align
ThisThisThis
columncolumncolumn
willwillwill
bebebe
leftrightcenter
alignedalignedaligned

Quote

Use > for citations.

> Quote
>> Quote

Quote

Quote

Code

Enclose the code in ```. It also supports code syntax.

```js
console.log('code with syntax')
```
console.log('code with syntax')
Was this page helpful?