logo
anand
@anand

6 months ago

Markdown Style Guide

Here is a sample of some basic Markdown syntax that can be used when writing blog posts.

Table Of Contents:

Here you will find a sample of some basic Markdown syntax that can be used when writing blog posts. You can also use HTML tags in Markdown. Once you are familiar with Markdown, you can use the Markdown Cheatsheet as a quick reference guide Or even this article itself as a reference guide.

You can find how the Markdown syntax is rendered by looking at source under each section.

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

# H1
💡 It's not semantically correct to use multiple H1 in the body of a blog post. It's reserved for the title of the blog post.

H2

## H2

H3

### H3

H4

#### H4
H5
##### H5
H6
###### H6

Paragraph

Any sequence of lines separated by one or more blank lines is a paragraph. A blank line is any line that looks like a blank line — a line containing nothing but spaces or tabs is considered blank. Normal paragraphs should not be indented with spaces or tabs.

This is a paragraph.

Images

This is a placeholder image description

![alt text](/img-src.jpg)

Details

Click to expand!

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed non risus. Suspendisse lectus tortor, dignissim sit amet, adipiscing nec, ultricies sed, dolor.

<details>
  <summary>Click to expand!</summary>
  <p>Text content that will be shown/hidden.</p>
</details>

Attribution

For attribution, you can dynamically generate a list of links to the original source material and/or authors using the <cite> element.

”This is a quote from somewhere” The source of the quote can be added as a footnote.1 Anand

_"This is a quote from somewhere"_
The source of the quote can be added as a footnote.[^1] <cite>Anand</cite>
 
[^1]: This is the footnote.

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.


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

Tables

ItalicsBoldCode
italicsboldcode

| 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 Multiple lines of code</p>
    <p>
      Test One line expanding through a long line of code Test One line expanding through a long
      line of codeTest One line expanding through a long line of codeTest One line expanding through
      a long line of codeTest One line expanding through a long line of codeTest One line expanding
      through a long line of code
    </p>
  </body>
</html>

```html
<!DOCTYPE html>
<html lang="en">
  ....
</html>
```

List Types

Ordered List

  1. First item
  2. Second item
  3. Third item
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

Inline style

test-inline

`test-inline`

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.

Test mark tag

<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. Test
<mark>mark tag</mark>

This is an external link: Google

This is an external link: [Google](https://google.com)

Footnotes

  1. This is the footnote.

  2. The above quote is excerpted from Rob Pike’s talk during Gopherfest, November 18, 2015.


Share this article