168 lines
No EOL
5.6 KiB
Markdown
168 lines
No EOL
5.6 KiB
Markdown
+++
|
|
author = "Hugo Authors"
|
|
title = "Markdown Syntax Guide"
|
|
date = "2019-03-11"
|
|
description = "Sample article showcasing basic Markdown syntax and formatting for HTML elements."
|
|
tags = [
|
|
"markdown",
|
|
"css",
|
|
"html",
|
|
"themes",
|
|
]
|
|
categories = [
|
|
"themes",
|
|
"syntax",
|
|
]
|
|
series = ["Themes Guide"]
|
|
aliases = ["migrate-from-jekyl"]
|
|
image = "pawel-czerwinski-8uZPynIu-rQ-unsplash.jpg"
|
|
+++
|
|
|
|
This article offers a sample of basic Markdown syntax that can be used in Hugo content files, also it shows whether basic HTML elements are decorated with CSS in a Hugo theme.
|
|
<!--more-->
|
|
|
|
## Headings
|
|
|
|
The following HTML `<h1>`—`<h6>` elements represent six levels of section headings. `<h1>` is the highest section level while `<h6>` is the lowest.
|
|
|
|
# H1
|
|
## H2
|
|
### H3
|
|
#### H4
|
|
##### H5
|
|
###### H6
|
|
|
|
## 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.
|
|
|
|
Itatur? Quiatae cullecum rem ent aut odis in re eossequodi nonsequ idebis ne sapicia is sinveli squiatum, core et que aut hariosam ex eat.
|
|
|
|
## 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.<br>
|
|
> — <cite>Rob Pike[^1]</cite>
|
|
|
|
[^1]: The above quote is excerpted from Rob Pike's [talk](https://www.youtube.com/watch?v=PAAkCSZUG1c) during Gopherfest, November 18, 2015.
|
|
|
|
## Tables
|
|
|
|
Tables aren't part of the core Markdown spec, but Hugo supports supports them out-of-the-box.
|
|
|
|
Name | Age
|
|
--------|------
|
|
Bob | 27
|
|
Alice | 23
|
|
|
|
#### Inline Markdown within tables
|
|
|
|
| Italics | Bold | Code |
|
|
| -------- | -------- | ------ |
|
|
| *italics* | **bold** | `code` |
|
|
|
|
| A | B | C | D | E | F |
|
|
|----------------------------------------------------------|---------------------------------------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------|------------------------------------------------------------|----------------------------------------------------------------------|
|
|
| Lorem ipsum dolor sit amet, consectetur adipiscing elit. | Phasellus ultricies, sapien non euismod aliquam, dui ligula tincidunt odio, at accumsan nulla sapien eget ex. | Proin eleifend dictum ipsum, non euismod ipsum pulvinar et. Vivamus sollicitudin, quam in pulvinar aliquam, metus elit pretium purus | Proin sit amet velit nec enim imperdiet vehicula. | Ut bibendum vestibulum quam, eu egestas turpis gravida nec | Sed scelerisque nec turpis vel viverra. Vivamus vitae pretium sapien |
|
|
|
|
## Code Blocks
|
|
|
|
#### Code block with backticks
|
|
|
|
```html
|
|
<!doctype html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<title>Example HTML5 Document</title>
|
|
</head>
|
|
<body>
|
|
<p>Test</p>
|
|
</body>
|
|
</html>
|
|
```
|
|
|
|
#### Code block indented with four spaces
|
|
|
|
<!doctype html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<title>Example HTML5 Document</title>
|
|
</head>
|
|
<body>
|
|
<p>Test</p>
|
|
</body>
|
|
</html>
|
|
|
|
#### Code block with Hugo's internal highlight shortcode
|
|
{{< highlight html >}}
|
|
<!doctype html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<title>Example HTML5 Document</title>
|
|
</head>
|
|
<body>
|
|
<p>Test</p>
|
|
</body>
|
|
</html>
|
|
{{< /highlight >}}
|
|
|
|
#### Diff code block
|
|
|
|
```diff
|
|
[dependencies.bevy]
|
|
git = "https://github.com/bevyengine/bevy"
|
|
rev = "11f52b8c72fc3a568e8bb4a4cd1f3eb025ac2e13"
|
|
- features = ["dynamic"]
|
|
+ features = ["jpeg", "dynamic"]
|
|
```
|
|
|
|
## List Types
|
|
|
|
#### Ordered List
|
|
|
|
1. First item
|
|
2. Second item
|
|
3. Third item
|
|
|
|
#### Unordered List
|
|
|
|
* List item
|
|
* Another item
|
|
* And another item
|
|
|
|
#### Nested list
|
|
|
|
* Fruit
|
|
* Apple
|
|
* Orange
|
|
* Banana
|
|
* Dairy
|
|
* Milk
|
|
* Cheese
|
|
|
|
## Other Elements — abbr, sub, sup, kbd, mark
|
|
|
|
<abbr title="Graphics Interchange Format">GIF</abbr> is a bitmap image format.
|
|
|
|
H<sub>2</sub>O
|
|
|
|
X<sup>n</sup> + Y<sup>n</sup> = Z<sup>n</sup>
|
|
|
|
Press <kbd>CTRL</kbd> + <kbd>ALT</kbd> + <kbd>Delete</kbd> to end the session.
|
|
|
|
Most <mark>salamanders</mark> are nocturnal, and hunt for insects, worms, and other small creatures.
|
|
|
|
## Hyperlinked image
|
|
|
|
[](https://google.com) |