Markdown Guide
Markdown is a lightweight markup language used within sections of Redbox for formatting text. Its main goal is to be easy to write and read in its raw form. Here’s a simple guide to get you started with Markdown.
Headings
Headings from h1
through h6
are constructed with a #
for each level:
# Heading 1
## Heading 2
### Heading 3
#### Heading 4
##### Heading 5
###### Heading 6
Emphasis
Bold: Wrap text with two asterisks or underscores.
**bold text** or __bold text__
Italic: Wrap text with one asterisk or underscore.
*italicized text* or _italicized text_
Lists
Unordered List
Use asterisks, plus, or minus signs for bullet points.
* Item 1
* Item 2
* Subitem 2.1
* Subitem 2.2
Ordered List
Use numbers followed by a period.
1. Item 1
2. Item 2
1. Subitem 2.1
2. Subitem 2.2
Links
To create a link, enclose the link text in brackets (e.g., [Google]
), and then follow it immediately with the URL in parentheses (e.g., (https://google.com)
).
[Google](https://google.com)
Images
Images are like links, but with an exclamation mark in front (!
), followed by the alt text in brackets, and the path or URL to the image asset in parentheses.
![Alt text](/path/to/img.jpg)
Code
For inline code, wrap the text with backticks (`). For code blocks, wrap the lines with three backticks (```) or indent every line with four spaces.
Inline code:
`Inline code`
Blockquotes
Use >
before the text to create a blockquote.
> This is a blockquote.
Horizontal Rule
Use three or more asterisks (***
), dashes (---
), or underscores (___
) on a line by themselves.
---
Escaping Characters
Use the backslash (\
) to escape Markdown characters.
\*This text is not in italics or bold\*
That's it! With these basics, you're ready to start using Markdown. Remember, the goal is to keep the syntax as readable and straightforward as possible, even in its raw form.