Markdown Style Guide


This is a sample blog post that demonstrates the Markdown syntax that is used in this project.

Headings

Syntax

```markdown

Heading 1

Heading 2

Heading 3

Heading 4

Heading 5
Heading 6

```

Output

Heading 1

Heading 2

Heading 3

Heading 4

Heading 5
Heading 6

Paragraphs

Syntax

```markdown This is a paragraph. ```

Output

This is a paragraph.

Images

Syntax

```markdown blog placeholder ```

Output

blog placeholder

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

Syntax

```markdown

Tiam, ad mint andaepu dandae nostion secatur sequo quae.
Note that you can use Markdown syntax within a blockquote. ```

Output

Tiam, ad mint andaepu dandae nostion secatur sequo quae.
Note that you can use Markdown syntax within a blockquote.

Blockquote with attribution

Syntax

```markdown

Don’t communicate by sharing memory, share memory by communicating.
Rob Pike1 ```

Output

Don’t communicate by sharing memory, share memory by communicating.
Rob Pike1

Tables

Syntax

```markdown

ItalicsBoldCode
italicsbold`code`
```

Output

ItalicsBoldCode
italicsbold`code`

Code Blocks

Syntax

we can use 3 backticks ``` in new line and write snippet and close with 3 backticks on new line and to highlight language specific syntax, write one word of language name after first 3 backticks, for eg. html, javascript, css, markdown, typescript, txt, bash

```html

Example HTML5 Document

Test

\`\`\`

Output

```html

Example HTML5 Document

Test

\`\`\`

Thematic Breaks

Syntax

```markdown



```

Output




Lists

Unordered

Syntax

```markdown

  • Dashed list item
  • Dashed list item
  • Dashed list item ```

Output

  • Dashed list item
  • Dashed list item
  • Dashed list item

Ordered

Syntax

```markdown

  1. Numbered list item
  2. Numbered list item
  3. Numbered list item ```

Output

  1. Numbered list item
  2. Numbered list item
  3. Numbered list item

Other Elements — abbr, sub, sup, kbd, mark

Syntax

```html 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. ```

Output

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.

Footnotes

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