minoplhy/hugo-bearblog
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
3b895022d3
hugo-bearblog/exampleSite/content/blog/markdown-syntax.md

5.4 KiB
Raw Blame History

+++ title = "Markdown Syntax Guide" date = "2020-01-03" description = "Sample article showcasing basic Markdown syntax and formatting for HTML elements." tags = [ "markdown", "syntax", ] +++

For a quick cheatsheet, check out https://simplemde.com/markdown-guide.

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.

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.
— Rob Pike1

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

<!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

html

{{< highlight html >}} <!doctype html>

<html lang="en"> <head> </head>

Test

</html> {{< /highlight >}}
python - lovelace

{{< highlight python "style=lovelace">}}

Copyright Andrew Jorgensen

SPDX-License-Identifier: MIT

"""Receive SNS events in Lambda and POST to a JSON Webhook.

Environment variables required:

  • URL - The Webhook URL to POST to (including any required keys)
  • TEMPLATE (default: {}) - The JSON data template to POST to the Webhook
  • MESSAGE_KEY (default: text) - Key to set to the SNS Message
  • TOPIC_KEY (optional) - Key to set to the Topic name from the SNS event """ import json from os import environ from urllib.request import urlopen, Request

CONTENT_TYPE = "application/json; charset=utf-8"

def lambda_handler(event, context): """Lambda handler - expects an SNS event""" user_agent = context.function_name print(json.dumps(dict(environ), sort_keys=True)) url = environ.get("URL") template = environ.get("TEMPLATE", "{}") message_key = environ.get("MESSAGE_KEY", "text") topic_key = environ.get("TOPIC_KEY")

print(json.dumps(event, sort_keys=True))
topic = event["Records"][0]["Sns"]["TopicArn"].rsplit(":", 1)[1]
subject = event["Records"][0]["Sns"]["Subject"]
message = event["Records"][0]["Sns"]["Message"]

data = json.loads(template)
if topic_key:
    data[topic_key] = topic
if subject:
    data[message_key] = f"{subject}: {message}"
else:
    data[message_key] = message
data = json.dumps(data, sort_keys=True)
print(data)

request = Request(
    url=url,
    data=data.encode("utf-8"),
    headers={"User-Agent": user_agent, "Content-Type": CONTENT_TYPE},
)
with urlopen(request) as response:
    print(response.read().decode("utf-8"))

{{< /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

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.

  1. The above quote is excerpted from Rob Pike's talk during Gopherfest, November 18, 2015. ↩︎