Markdown is a markup language that allows you to create formatted text using a text editor. It is used to create README files, blog posts, and other types of documentation.
To get started, you will need to install a text editor. Some popular text editors include:
Sublime Text
Visual Studio Code
Atom
Notepad++
Once you have installed a plain text editor, you can start writing in Markdown. Write your content using Markdown syntax, and save it with the name of the file .md
--for example; my_wagtaildoc.md
. Here are the most common Markdown syntax:
PermalinkHeadings
You can make headings by using hashtags (#)
. The more hashtags you use, the smaller the heading.
Input:
# Heading 1
## Heading 2
### Heading 3
#### Heading 4
##### Heading 5
###### Heading 6
Output:
PermalinkLists
Markdown supports both ordered and unordered lists.
PermalinkUnordered List
For an unordered list, use asterisks *
, plus signs +
, or hyphens -
Input:
- Outreachy Task 1
- Outreachy Task 2
- Outreachy Task 2.1
- Outreachy Task 2.2
- Outreachy Task 3
Output:
PermalinkOrdered List
For an ordered list, use numbers followed by a period.
Input:
1. Wagtail Checklist 1
2. Wagtail Checklist 2
3. Wagtail Checklist 3
Output:
PermalinkLinks
To add a link, you put the link text in square brackets ([])
and the URL in parentheses (())
.
Input:
[Understanding Accessibility](https://elysium.hashnode.dev/understanding-accessibility)
Output:
The reason you're seeing the actual link is because my cursor was on "understanding Accessibility" which is showing in Light blue because it's carrying the link.
PermalinkEmphasis
To make the text italic, use asterisks or underscores.
Input:
*Outreachy* or _Outreachy_
Output:
Outreachy
To make text bold, use two asterisks or underscores.
Input:
**Wagtail** or __Wagtail__
Output:
Wagtail
PermalinkImages
To insert images, you use an exclamation mark (!)
before the link format.
Input:
![A doodle image of a girl holding a search icon on her right hand and a phone on her left hand--with different icons (a hand holding a book, an ear, a pair of eyes, a light bulb, a brain, a phone, and a padlock) around her.](https://cdn.hashnode.com/res/hashnode/image/upload/v1698405223580/b00423d0-0f28-4446-a328-fa14c9add7ac.png?auto=compress,format&format=webp)
Output:
PermalinkQuotes
You can add quotes by using the greater-than symbol (>).
Input:
> Wagtail is an amazing CMS tool to use when creating your own blog.
Output:
PermalinkCode
To add code snippets, you can use backticks (`)
for inline code or three backticks (```)
for code blocks.
Input:
To start using python, you use this code `print("Hello, World!")`
or
To start using python, you use this code ```print("Hello, World!")
```
Output:
PermalinkConclusion
Markdown is an efficient way to create web-ready content without the need for complex formatting tools. With this guide, you have the basic knowledge needed to get started and start writing on the web in an organized manner