K5DBasic Markdown Syntax
This article offers a sample of basic Markdown syntax that can be used in Hugo content files.
This article is a shameful copy of the great Grav original page.
If you want to know about the extented Markdown syntax of DoIt theme, please read extended Markdown syntax page.
Let’s face it: Writing content for the Web is tiresome. WYSIWYG editors help alleviate this task, but they generally result in horrible code, or worse yet, ugly web pages.
Markdown is a better way to write HTML, without all the complexities and ugliness that usually accompanies it.
Some of the key benefits are:
- Markdown is simple to learn, with minimal extra characters, so it’s also quicker to write content.
- Less chance of errors when writing in Markdown.
- Produces valid XHTML output.
- Keeps the content and the visual display separate, so you cannot mess up the look of your site.
- Write in any text editor or Markdown application you like.
- Markdown is a joy to use!
John Gruber, the author of Markdown, puts it like this:
The overriding design goal for Markdown’s formatting syntax is to make it as readable as possible. The idea is that a Markdown-formatted document should be publishable as-is, as plain text, without looking like it’s been marked up with tags or formatting instructions. While Markdown’s syntax has been influenced by several existing text-to-HTML filters, the single biggest source of inspiration for Markdown’s syntax is the format of plain text email.
– John Gruber
Without further delay, let us go over the main elements of Markdown and what the resulting HTML looks like!
1 Headings
Headings from h2 through h6 are constructed with a # for each level:
|
|
The HTML looks like this:
|
|
To add a custom heading ID, enclose the custom ID in curly braces on the same line as the heading:
|
|
The HTML looks like this:
|
|
2 Comments
Comments should be HTML compatible.
|
|
Comment below should NOT be seen:
3 Horizontal Rules
The HTML <hr> element is for creating a “thematic break” between paragraph-level elements.
In Markdown, you can create a <hr> with any of the following:
___: three consecutive underscores---: three consecutive dashes***: three consecutive asterisks
The rendered output looks like this:
4 Body Copy
Body copy written as normal, plain text will be wrapped with <p></p> tags in the rendered HTML.
So this body copy:
|
|
The HTML looks like this:
|
|
A line break can be done with one blank line.
5 Inline HTML
If you need a certain HTML tag (with a class) you can simply use HTML:
|
|
6 Emphasis
6.1 Bold
For emphasizing a snippet of text with a heavier font-weight.
The following snippet of text is rendered as bold text.
|
|
The HTML looks like this:
|
|
6.2 Italics
For emphasizing a snippet of text with italics.
The following snippet of text is rendered as italicized text.
|
|
The HTML looks like this:
|
|
6.3 Strikethrough
In GFM you can do strikethroughs.
|
|
The rendered output looks like this:
Strike through this text.
The HTML looks like this:
|
|
6.4 Combination
Bold, italics, and strikethrough can be used in combination.
|
|
The rendered output looks like this:
bold and italics
strikethrough and bold
strikethrough and italics
bold, italics and strikethrough
The HTML looks like this:
|
|
7 Blockquotes
For quoting blocks of content from another source within your document.
Add > before any text you want to quote:
|
|
The rendered output looks like this:
Fusion Drive combines a hard drive with a flash storage (solid-state drive) and presents it as a single logical volume with the space of both drives combined.
The HTML looks like this:
|
|
Blockquotes can also be nested:
|
|
The rendered output looks like this:
Donec massa lacus, ultricies a ullamcorper in, fermentum sed augue. Nunc augue augue, aliquam non hendrerit ac, commodo vel nisi.
Sed adipiscing elit vitae augue consectetur a gravida nunc vehicula. Donec auctor odio non est accumsan facilisis. Aliquam id turpis in dolor tincidunt mollis ac eu diam.
8 Lists
8.1 Unordered
A list of items in which the order of the items does not explicitly matter.
You may use any of the following symbols to denote bullets for each list item:
|
|
For example:
|
|
The rendered output looks like this:
- Lorem ipsum dolor sit amet
- Consectetur adipiscing elit
- Integer molestie lorem at massa
- Facilisis in pretium nisl aliquet
- Nulla volutpat aliquam velit
- Phasellus iaculis neque
- Purus sodales ultricies
- Vestibulum laoreet porttitor sem
- Ac tristique libero volutpat at
- Faucibus porta lacus fringilla vel
- Aenean sit amet erat nunc
- Eget porttitor lorem
The HTML looks like this:
|
|
8.2 Ordered
A list of items in which the order of items does explicitly matter.
|
|
The rendered output looks like this:
- Lorem ipsum dolor sit amet
- Consectetur adipiscing elit
- Integer molestie lorem at massa
- Facilisis in pretium nisl aliquet
- Nulla volutpat aliquam velit
- Faucibus porta lacus fringilla vel
- Aenean sit amet erat nunc
- Eget porttitor lorem
The HTML looks like this:
|
|
If you just use 1. for each number, Markdown will automatically number each item. For example:
|
|
The rendered output looks like this:
- Lorem ipsum dolor sit amet
- Consectetur adipiscing elit
- Integer molestie lorem at massa
- Facilisis in pretium nisl aliquet
- Nulla volutpat aliquam velit
- Faucibus porta lacus fringilla vel
- Aenean sit amet erat nunc
- Eget porttitor lorem
8.3 Task Lists
Task lists allow you to create a list of items with checkboxes. To create a task list, add dashes (-) and brackets with a space ([ ]) before task list items. To select a checkbox, add an x in between the brackets ([x]).
|
|
The rendered output looks like this:
- Write the press release
- Update the website
- Contact the media
9 Code
9.1 Inline Code
Wrap inline snippets of code with `.
|
|
The rendered output looks like this:
In this example, <section></section> should be wrapped as code.
The HTML looks like this:
|
|
9.2 Indented Code
Or indent several lines of code by at least four spaces, as in:
|
|
The rendered output looks like this:
// Some comments
line 1 of code
line 2 of code
line 3 of code
The HTML looks like this:
|
|
9.3 Block Fenced Code
Use “fences” ``` to block in multiple lines of code with a language attribute.
|
|
The HTML looks like this:
|
|
9.4 Syntax Highlighting
GFM also supports syntax highlighting.
To activate it, simply add the file extension of the language you want to use directly after the first code “fence”,
```js, and syntax highlighting will automatically be applied in the rendered HTML.
For example, to apply syntax highlighting to JavaScript code:
|
|
The rendered output looks like this:
|
|
10 Tables
Tables are created by adding pipes as dividers between each cell, and by adding a line of dashes (also separated by bars) beneath the header. Note that the pipes do not need to be vertically aligned.
|
|
The rendered output looks like this:
| Option | Description |
|---|---|
| data | path to data files to supply the data that will be passed into templates. |
| engine | engine to be used for processing templates. Handlebars is the default. |
| ext | extension to be used for dest files. |
The HTML looks like this:
|
|
Adding a colon on the right side of the dashes below any heading will right align text for that column.
Adding colons on both sides of the dashes below any heading will center align text for that column.
|
|
The rendered output looks like this:
| Option | Description |
|---|---|
| data | path to data files to supply the data that will be passed into templates. |
| engine | engine to be used for processing templates. Handlebars is the default. |
| ext | extension to be used for dest files. |
11 Links
11.1 Basic Link
|
|
The rendered output looks like this (hover over the link, there is no tooltip):
The HTML looks like this:
|
|
11.2 Add a Title
|
|
The rendered output looks like this (hover over the link, there should be a tooltip):
The HTML looks like this:
|
|
11.3 Named Anchors
Named anchors enable you to jump to the specified anchor point on the same page. For example, each of these chapters:
|
|
will jump to these sections:
|
|
12 Footnotes
Footnotes allow you to add notes and references without cluttering the body of the document. When you create a footnote, a superscript number with a link appears where you added the footnote reference. Readers can click the link to jump to the content of the footnote at the bottom of the page.
To create a footnote reference, add a caret and an identifier inside brackets ([^1]). Identifiers can be numbers or words, but they can’t contain spaces or tabs. Identifiers only correlate the footnote reference with the footnote itself — in the output, footnotes are numbered sequentially.
Add the footnote using another caret and number inside brackets with a colon and text ([^1]: My footnote.). You don’t have to put footnotes at the end of the document. You can put them anywhere except inside other elements like lists, block quotes, and tables.
|
|
This is a digital footnote1.
This is a footnote with “label”2
13 Images
Local images in assets folder
|
|
Images have a similar syntax to links but include a preceding exclamation point.
|
|
or:
|
|
Like links, images also have a footnote style syntax:
|
|
With a reference later in the document defining the URL location:
|
|