hello there!
This page will be used as a documentation on markdown (lightweight markup language). This is my personal “guide” that I made while exploring the syntaxe, and if you need help you should check the Markdown Guide or a Markdown Cheatsheet.
| Elements | How to | Notes |
|---|---|---|
| Italic | _Text_ | |
| Bold | **Text** | |
| Headers | # Header 1 | not recommended to use big headers |
| ## Header 2 | better to just use ## like a content table | |
| ###### Header 6 | and then # where you want to point to | |
| Inline Link | [Text](link) | |
| Reference Link | [Text][reference] [reference]:link | this seems useful for lots of the same link |
| Inline Image Link |  | to display an image which is in the repository, use relative links instead of absolute links. |
| Reference Image: | [Alt Text][reference] | [reference]:link (same as without image) |
| Quote Block | > Text | usefull to highlight a snippet of text from the rest |
| Unordered List | * Item | |
| Ordered List | 1. Item | |
| Line Break | 2 spaces end of line | it can be good for lists but doesn’t work well on tables |
| Code Block | 2 TABS or 4 spaces | it’s a good idea to indent the code! |
| Horizontal Bar | -——— | a thinner is created on “headers” so it’s not that useful |
italic
Emphasis, aka italics, with *asterisks* or _underscores._
bold
Strong emphasis, aka bold, with **asterisks or underscores.**
headers
H1
H2
H6
inline-link
reference-link
inline-image
Same result as reference
reference-image
quote-block
This is a quote
unordered-list
- Milk
- Eggs
- Cookies
ordered-list
- Gold
- Silver
- Bronze
Bronze is underatted
line-break
How are you here?
That’s pretty awesome!
code-block
fn main() {
println!("Hello, world!");
}
horizontal-bar
Thank you for finding this page, and remember to check out the resources used on this document, or others more directed to help learn how to use Markdown!