Markdown Guide

Headings

Styles for Headings

#h1 heading

##h2 heading

###h3 heading

####h4 heading

#####h5 heading

Code

Styles for how to include code into the documents.

Inline code with no sample

{% highlight html %}

<html>
    <head>
      <title>Hello World</title>
    </head>
</html>

{% endhighlight %}

<html>
  <head>
    <title>Hello World</title>
  </head>
</html>

Include Javascript

{% include_code _code/test.js testjs javascript %}

    console.log('Hello World');
View full sample

Include HTML

{% include_code _code/test.html testhtml html %}

    <!DOCTYPE html>
    <html lang="en">
      <head>
            <title>Article Example: sample example</title>
      </head>
      <body>
        <div role="main">
          Hello, world.
        </div>
        </body>
    </html>
    
View full sample

Include CSS

{% include_code _code/test.css testcss css %}

    html, body {
    	padding: 10px;
    }
View full sample

{% link_sample _code/test.html %}See sample{% endlink_sample %}

See sample

Callouts

Using Callouts in your doc is easy.

Key takeaway

{% include modules/takeaway.liquid
	list=page.key-takeaways.use-keytakeaway %}

In your Article YAML Preamble

key-takeaways:
  use-keytakeaway:
    - It is pretty simple to add in a key takeaway

TL;DR

  • It is pretty simple to add in a key takeaway

Remember

{% include modules/remember.liquid
	list=page.remember.use-remember %}

In your Article YAML Preamble

remember:
  use-remember:
    - It is pretty simple to add in a remember

Remember

  • It is pretty simple to add in a remember
{% include modules/related.liquid
  list=page.related.related-content %}

In your Article YAML Preamble

related:
  related-content:
    - <a href="index.html">Style Guide</a>
    - <a href="../example-article/">Example Article</a>