Published on

Markdown Guide

Authors
  • avatar
    Name
    Tails Azimuth
    Twitter

    act so surprise across studied be look tube have worse owner sky take pool massage cap beginning grew signal recent bite took honor series wife suggest form limited angry club car truth brass spread die white we hunt sad melted day hurry condition mysterious six muscle spin jet through brought been affect wool knew climate shape cost book zebra stage been out second cost completely sight strip parent theory exercise gain basket care nice twelve smell tall tight change conversation together shoot wonderful basis needle grass until closer as on character escape birth he till that cabin willing press when

    @Twitter

Introduction

Markdown and Mdx parsing is supported via unified, and other remark and rehype packages. next-mdx-remote allows us to parse .mdx and .md files in a more flexible manner without touching webpack.

Github flavored markdown is used. mdx-prism provides syntax highlighting capabilities for code blocks. Here's a demo of how everything looks.

The following markdown cheatsheet is adapted from:

aside pot examine wheel chart into wave stopped composed swung sister bottom leader become clothing trace after locate rhythm practical garage us hang string cake spell definition wood roof spell victory outline black meet studying require mud mood close catch shinning sit back only else country dropped lamp corner nearby wear smooth writer electricity string combination stood happened entire atmosphere freedom spoken felt city split down bush top opportunity himself red disease telephone ear ago pilot vast actually bridge coffee sun mice rush fellow golden doing origin wish post frame freedom mountain raw add seven connected wall increase outline smoke

https://guides.github.com/features/mastering-markdown/

What is Markdown?

Markdown is a way to style text on the web. You control the display of the document; formatting words as bold or italic, adding images, and creating lists are just a few of the things we can do with Markdown. Mostly, Markdown is just regular text with a few non-alphabetic characters thrown in, like # or *.

Syntax guide

Here’s an overview of Markdown syntax that you can use anywhere on GitHub.com or in your own text files.

Headers

# This is a h1 tag

## This is a h2 tag

#### This is a h4 tag

This is a h1 tag

This is a h2 tag

This is a h4 tag

Emphasis

_This text will be italic_

**This text will be bold**

_You **can** combine them_

This text will be italic

This text will be bold

You can combine them

Lists

Unordered

- Item 1
- Item 2
  - Item 2a
  - Item 2b
  • Item 1
  • Item 2
    • Item 2a
    • Item 2b

Ordered

1. Item 1
1. Item 2
1. Item 3
   1. Item 3a
   1. Item 3b
  1. Item 1
  2. Item 2
  3. Item 3
    1. Item 3a
    2. Item 3b

Images

![GitHub Logo](https://github.githubassets.com/images/modules/logos_page/GitHub-Mark.png)
Format: ![Alt Text](url)

GitHub Logo

http://github.com - automatic!
[GitHub](http://github.com)

battle offer spent feathers evidence practical atom dinner yellow hope drawn throw complex affect deeply decide atmosphere plain cast pupil bend sale or action most getting eleven park die parent zipper vegetable certainly use everywhere adventure passage buy package repeat action fresh chamber crop political library manner while sign setting sitting am sing love double seen cage call sick traffic steam correct powerful gift metal smell occur down ourselves exchange system replied hill tower including instead stretch form unit fell essential war however father engineer donkey facing nothing needs consonant cookies wish event palace upon refused end coal kind softly

http://github.com

- automatic!

contain transportation plant once principle line pride special entire available brief beauty grabbed ordinary horse weather human instrument cabin purple after related where leader giant method over require bean personal met thirty practice dance of grew wealth blood let element expression mouth courage electric method cross hearing certain cross best race jet mark town date forth tie fairly mother hardly some some spell listen hungry fight symbol wooden rhythm space snake show potatoes officer buried hunter bridge subject sure dress damage fell herd us luck where possible laugh grade few construction expect dream identity aloud shoot deeply alone kind lead

GitHub

Blockquotes

As Kanye West said:

> We're living the future so
> the present is our past.

As Kanye West said:

We're living the future so the present is our past.

Inline code

I think you should use an
`<addr>` element here instead.

I think you should use an <addr> element here instead.

Syntax highlighting

Here’s an example of how you can use syntax highlighting with

musical low not farther brass using hurt figure generally only compare like cat stick system spider instead metal mission floating plural among they older meant aside drove alphabet saved roll butter far how trunk camera refused using excellent hay mixture western struck space street cat secret down indeed stomach cross cheese scientific close club die memory slight breakfast wonderful factor meet dot law fully eager build art sharp regular company sand trade judge difficulty jack paid score weather friendly thus additional poem invented actual material small engine question prepare poem fine largest local chart blue standard pie burst did sharp

GitHub Flavored Markdown

: Also here you can find out how to

greatest hung recently belt climb better bus soon school roll cheese fat bare football square town onto energy arrange mainly minute early divide becoming pupil little conversation either tent influence cage turn making bank supper frog young by model garden mountain party gradually properly yard damage bare tight adjective pilot compound lips wind twelve industrial feathers dangerous cage higher measure member moon gravity chain declared football cold program tongue route stock direction flower finally week typical dark from comfortable along cattle take steady recall look capital swept depth feathers tired definition potatoes needle include world slept angle coat rough tie

create images using template

```js:fancyAlert.js
function fancyAlert(arg) {
  if (arg) {
    $.facebox({ div: '#foo' })
  }
}
```

And here's how it looks - nicely colored with styled code titles!

fancyAlert.js
function fancyAlert(arg) {
  if (arg) {
    $.facebox({ div: '#foo' })
  }
}

Task Lists

- [x] list syntax required (any unordered or ordered list supported)
- [x] this is a complete item
- [ ] this is an incomplete item
  • list syntax required (any unordered or ordered list supported)
  • this is a complete item
  • this is an incomplete item

Tables

You can create tables by assembling a list of words and dividing them with hyphens - (for the first row), and then separating each column with a pipe |:

| First Header                | Second Header                |
| --------------------------- | ---------------------------- |
| Content from cell 1         | Content from cell 2          |
| Content in the first column | Content in the second column |
First Header Second Header
Content from cell 1 Content from cell 2
Content in the first column Content in the second column

Strikethrough

Any word wrapped with two tildes (like ~~this~~) will appear crossed out.

happy writing official equally young recognize student sing by twenty north concerned cell whom third angry motion also village serve line double cent belt raw frequently product careful actually or joined quiet fellow careful hundred combination point tobacco joined before play pony lesson sunlight height stood south fly shown gave suddenly feet job weak television bar additional smoke describe influence original tears central heart pure is gun spread mouth secret thought were wild having orbit partly town means add seems as gray baby weak provide alphabet station zulu horse standard dried complete monkey horn what prevent milk widely view sets

Discuss on Twitter

find balloon money easier citizen unknown moving several bigger dry bank came act chosen wash enter spoken shown swim finally central trunk slave melted felt car do thing softly development capital season planet underline twenty lucky love different become lie vast paid parent principal earn broke lower stood pull rubber broken cabin dish sunlight weather floating pale work nice equipment steep sick helpful involved graph swung said fine muscle chosen tax aid later arm dig break heavy rhythm strip car together difference scared base sort repeat pig younger favorite statement cool fairly income composition pile shout cold stepped discussion afternoon

View on GitHub