Welcome to my Markdown Style Guide
This post covers the basics of Markdown syntax. Learn about headings, images, blockquotes, tables, code blocks, and lists. Plus, we’ll introduce YAML Front Matter for metadata. Improve your Markdown skills and create great content for your site. Let’s dive in! 🚀
Here is a sample of some basic Markdown syntax that can be used when writing Markdown content in Astro.
Headings
The following HTML <h1>—<h6> elements represent six levels of section headings. <h1> is the highest section level while <h6> is the lowest.
H2
H3
H4
Paragraph
Xerum, quo qui aut unt expliquam qui dolut labo. Aque venitatiusda cum, voluptionse latur sitiae dolessi aut parist aut dollo enim qui voluptate ma dolestendit peritin re plis aut quas inctum laceat est volestemque commosa as cus endigna tectur, offic to cor sequas etum rerum idem sintibus eiur? Quianimin porecus evelectur, cum que nis nust voloribus ratem aut omnimi, sitatur? Quiatem. Nam, omnis sum am facea corem alique molestrunt et eos evelece arcillit ut aut eos eos nus, sin conecerem erum fuga. Ri oditatquam, ad quibus unda veliamenimin cusam et facea ipsamus es exerum sitate dolores editium rerore eost, temped molorro ratiae volorro te reribus dolorer sperchicium faceata tiustia prat.
Images
Blockquotes
The blockquote element represents content that is quoted from another source, optionally with a citation which must be within a footer or cite element, and optionally with in-line changes such as annotations and abbreviations.
Blockquote without attribution
Tiam, ad mint andaepu dandae nostion secatur sequo quae. Note that you can use Markdown syntax within a blockquote.
Blockquote with attribution
Don’t communicate by sharing memory, share memory by communicating.
— Rob Pike1
Tables
| Italics | Bold | Code |
|---|---|---|
| italics | bold | code |
Code Blocks
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8" />
<title>Example HTML5 Document</title>
</head>
<body>
<p>Test</p>
</body>
</html><!doctype html>
<html lang="en">
<head>
<meta charset="utf-8" />
<title>Example HTML5 Document</title>
</head>
<body>
<p>Test</p>
</body>
</html>List Types
Ordered list
- First item
- Second item
- Third item
Unordered List
- List item
- Another item
- And another item
Nested list
- Fruit
- Apple
- Orange
- Banana
- Dairy
- Milk
- Cheese
Yaml - Front Matter
YAML Front Matter is a block of YAML syntax at the top of a file that’s used for storing metadata about the file. It is commonly used in static site generators like Jekyll and Hugo to add metadata to markdown files. The front matter is delimited by three dashes (---) at the top and bottom of the block. The data in between the dashes is the metadata for that file, written in YAML.
For example, you might use front matter to store the title of a page, its description, a publication date, cover image, tags, and other similar information. This metadata can then be accessed and used by the static site generator when building the site.
Below are some examples of the metadata that can be utilized on this website:
---
title: "Markdown Style Guide"
description: "Here is a sample of some basic Markdown syntax that can be used when writing Markdown content in Astro. Here is a sample of some basic Markdown syntax that can be used when writing Markdown content in Astro. Here is a sample of some basic Markdown syntax that can be used when writing Markdown content in Astro."
publishedAt: "Jul 01 2022"
isDraft: false
---
# Hello WorldOther Elements — abbr, sub, sup, kbd, mark
GIF is a bitmap image format.
H2O
Xn + Yn = Zn
Press CTRL+ALT+Delete to end the session.
Most salamanders are nocturnal, and hunt for insects, worms, and other small creatures.