You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
164 lines
4.8 KiB
Markdown
164 lines
4.8 KiB
Markdown
---
|
|
authors: ["will-faught"]
|
|
categories: ["content", "paige"]
|
|
description: "Sample article showcasing basic Markdown syntax and formatting for HTML elements."
|
|
tags: ["markdown", "css", "html"]
|
|
title: "Markdown Syntax Guide"
|
|
weight: 10
|
|
---
|
|
|
|
<!--
|
|
The MIT License (MIT)
|
|
|
|
Copyright (c) 2014 Steve Francia
|
|
|
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
of this software and associated documentation files (the "Software"), to deal
|
|
in the Software without restriction, including without limitation the rights
|
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
copies of the Software, and to permit persons to whom the Software is
|
|
furnished to do so, subject to the following conditions:
|
|
|
|
The above copyright notice and this permission notice shall be included in all
|
|
copies or substantial portions of the Software.
|
|
|
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
SOFTWARE.
|
|
-->
|
|
|
|
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 `<h2>`—`<h6>` elements represent five levels of section headings. `<h2>` is the highest section level while `<h6>` is the lowest.
|
|
|
|
## 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` |
|
|
|
|
## 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 >}}
|
|
|
|
## 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><kbd>CTRL</kbd>+<kbd>ALT</kbd>+<kbd>Delete</kbd></kbd> to end the session.
|
|
|
|
Most <mark>salamanders</mark> are nocturnal, and hunt for insects, worms, and other small creatures.
|