Skip to content

Instantly share code, notes, and snippets.

@roachhd
Created November 11, 2014 09:15
Show Gist options
  • Save roachhd/779fa77e9b90fe945b0c to your computer and use it in GitHub Desktop.
Save roachhd/779fa77e9b90fe945b0c to your computer and use it in GitHub Desktop.
Jekyll Markdown Quick Reference

#Jekyll Markdown Quick Reference

####Write in simply awesome markdown

layout: post
title: Markdown Style Guide
---

This is a demo of all styled elements in Jekyll Now. 

[View the markdown used to create this post](https://raw.githubusercontent.com/barryclark/www.jekyllnow.com/gh-pages/_posts/2014-6-19-Markdown-Style-Guide.md).

This is a paragraph, it's surrounded by whitespace. Next up are some headers, they're heavily influenced by GitHub's markdown style.

## Header 2 (H1 is reserved for post titles)##

### Header 3

#### Header 4
 
A link to [Jekyll Now](http://github.com/barryclark/jekyll-now/). A big ass literal link <http://github.com/barryclark/jekyll-now/>
  
An image, located within /images

![an image alt text]({{ site.baseurl }}/images/jekyll-logo.png "an image title")

* A bulletted list
- alternative syntax 1
+ alternative syntax 2
  - an indented list item

1. An
2. ordered
3. list

Inline markup styles: 

- _italics_
- **bold**
- `code()` 
 
> Blockquote
>> Nested Blockquote 
 
Syntax highlighting can be used by wrapping your code in a liquid tag like so:

{{ "{% highlight javascript " }}%}  
/* Some pointless Javascript */
var rawr = ["r", "a", "w", "r"];
{{ "{% endhighlight " }}%}  

creates...

{% highlight javascript %}
/* Some pointless Javascript */
var rawr = ["r", "a", "w", "r"];
{% endhighlight %}
 
Use two trailing spaces  
on the right  
to create linebreak tags  
 
Finally, horizontal lines
 
----
****

####See below for how it beautifully renders in HTML 😉


layout: post title: Markdown Style Guide

This is a demo of all styled elements in Jekyll Now.

View the markdown used to create this post.

This is a paragraph, it's surrounded by whitespace. Next up are some headers, they're heavily influenced by GitHub's markdown style.

Header 2 (H1 is reserved for post titles)##

Header 3

Header 4

A link to Jekyll Now. A big ass literal link http://github.com/barryclark/jekyll-now/

An image, located within /images

![an image alt text]({{ site.baseurl }}/images/jekyll-logo.png "an image title")

  • A bulletted list
  • alternative syntax 1
  • alternative syntax 2
    • an indented list item
  1. An
  2. ordered
  3. list

Inline markup styles:

  • italics
  • bold
  • code()

Blockquote

Nested Blockquote

Syntax highlighting can be used by wrapping your code in a liquid tag like so:

{{ "{% highlight javascript " }}%}
/* Some pointless Javascript */ var rawr = ["r", "a", "w", "r"]; {{ "{% endhighlight " }}%}

creates...

{% highlight javascript %} /* Some pointless Javascript */ var rawr = ["r", "a", "w", "r"]; {% endhighlight %}

Use two trailing spaces
on the right
to create linebreak tags

Finally, horizontal lines



@ArikVoronov
Copy link

Thanks , this is very helpful!

@JonLevy
Copy link

JonLevy commented May 1, 2021

It looks like the syntax highlighting in the preview is broken. At least for me, it doesn't have any fancy rendering.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment