---
title: "Markdown guide"
slug: "markdown-guide"
description: "A guide built to make your usage of markdown to format text a bit clearer. View it here."
tags: ["markdown"]
updated: 2023-11-02T18:39:46Z
published: 2023-11-02T18:39:46Z
canonical: "learn.allspice.io/markdown-guide"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://learn.allspice.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Markdown guide

## Markdown Guide

Markdown is a lightweight markup language with plain-text formatting syntax. Its main goal is to be easy to read and write, even when not converted to HTML. Here's how you can use Markdown to format text.

## Headings

Use `#` symbols before your header text to create headings. More `#` symbols indicate a smaller heading size.

```
# Heading 1
## Heading 2
### Heading 3
#### Heading 4
##### Heading 5
###### Heading 6
```

## Emphasis

You can create bold or italic text:

```
*This text will be italic*
_This will also be italic_

**This text will be bold**
__This will also be bold__

_You **can** combine them_
```

## Lists

### Unordered Lists

Use asterisks `*`, plus `+`, or hyphens `-` for bullet points:

```
* Item 1
* Item 2
  * Item 2a
  * Item 2b
```

### Ordered Lists

Use numbers followed by periods for an ordered list:

```
1. Item 1
2. Item 2
3. Item 3
   1. Item 3a
   2. Item 3b
```

## Links

Create a link by wrapping the link text in brackets `[ ]`, and then wrapping the URL in parentheses `( )`.

```
[GitHub](http://github.com)
```

## Images

Link images by starting with an exclamation mark `!`, followed by the alt text in brackets `[ ]`, and the path or URL to the image in parentheses `( )`.

```
![GitHub Logo](/images/logo.png)
```

## Blockquotes

Use the `>` character in front of a line to create a blockquote.

```
> This is a blockquote.
```

## Inline Code

Use single backticks ` to denote inline code.

```
`var example = true`
```

## Code Blocks

Use triple backticks ``` or indent with four spaces to create a code block.

```
```javascript
function test() {
  console.log("notice the blank line before this function?");
}
```
```

## Horizontal Rule

Use three or more hyphens `---`, asterisks `***`, or underscores `___` to create a horizontal rule.

```
---

***

___
```

## Tables

Create tables by separating headers with hyphens `-` and separating columns with pipes `|`.

```
| Header One    | Header Two    |
| ------------- | ------------- |
| Item One      | Item Two      |
```

---

This guide covers the basics, but Markdown has many other features, such as footnotes, abbreviations, and definition lists. You can find more information by looking up the official Markdown guide or other resources online.