hugo-theme-relearn/cont/markdown/index.html

696 lines
61 KiB
HTML
Raw Normal View History

<!doctype html><html lang=en class="js csstransforms3d">
<head>
<meta charset=utf-8>
<meta name=viewport content="width=device-width,initial-scale=1">
<meta name=generator content="Hugo 0.88.1">
<meta name=description content="Documentation for Hugo Relearn Theme">
<meta name=author content="Sören Weber">
<link rel="shortcut icon" href=../../images/logo.svg>
<title>Markdown syntax :: Documentation for Hugo Relearn Theme</title>
<link href=../../css/nucleus.css?1634426281 rel=stylesheet>
<link href=../../css/fontawesome-all.min.css?1634426281 rel=stylesheet>
<link href=../../css/featherlight.min.css?1634426281 rel=stylesheet>
<link href=../../css/perfect-scrollbar.min.css?1634426281 rel=stylesheet>
<link href=../../css/auto-complete.css?1634426281 rel=stylesheet>
<link href=../../css/theme.css?1634426281 rel=stylesheet>
<link href=../../css/theme-relearn.css?1634426281 rel=stylesheet>
<link href=../../css/variant.css?1634426281 rel=stylesheet>
<link href=../../css/print.css?1634426281 rel=stylesheet media=print>
<script src=../../js/jquery.min.js?1634426281></script>
<style>:root #header+#content>#left>#rlblock_left{display:none!important}</style>
</head>
<body data-url=../../cont/markdown/>
<nav id=sidebar class=showVisitedLinks>
<div id=header-wrapper>
<div id=header>
<a id=logo href=../../en style="color:#3d414d;font-family:novacento sans wide,helvetica,tahoma,geneva,arial,sans-serif;font-size:30px;font-weight:700;margin-top:-2px"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 64.044 64.044" style="height:65px;margin-bottom:-20px;margin-top:-20px;width:65px"><path d="M46.103 136.34c-.642-.394-1.222-2.242-1.98-2.358-.76-.117-1.353.506-1.618 1.519-.266 1.012-.446 4.188.173 5.538.213.435.482.787 1.03.845.547.057.967-.504 1.45-1.027.482-.523.437-.9 1.142-.612.705.289 1.051.4 1.586 1.229.535.828 1.085 4.043.868 5.598-.241 1.458-.531 2.8-.59 4.088.26.075.517.148.772.217 2.68.724 5.373 1.037 7.873.02.001-.028.01-.105.008-.11-.048-.165-.18-.41-.36-.698-.18-.29-.414-.645-.586-1.114a3.212 3.212.0 01-.125-1.735c.056-.21.153-.342.249-.475 1.237-1.193 2.932-1.373 4.244-1.384.557-.004 1.389.016 2.198.255s1.706.724 2.068 1.843c.187.578.114 1.17-.043 1.623-.153.438-.369.783-.545 1.091-.178.31-.329.6-.401.821-.007.02-.003.071-.005.094 2.256 1.008 4.716.91 7.189.398.55-.114 1.11-.247 1.673-.377.344-1.085.678-2.145.852-3.208.124-.752.158-2.311-.078-3.538-.118-.613-.306-1.15-.52-1.489-.221-.349-.413-.501-.747-.538-.243-.027-.51.013-.796.098-.67.223-1.33.606-1.966.76l-.008.002-.109.032c-.556.152-1.233.158-1.797-.36-.556-.51-.89-1.367-1.117-2.596-.283-1.528-.075-3.279.89-4.518l.071-.09h.07c.65-.71 1.485-.802 2.16-.599.706.213 1.333.629 1.772.84.736.354 1.185.319 1.475.171.291-.148.5-.439.668-.955.332-1.017.301-2.819.022-4.106-.148-.684-.13-1.292-.13-1.883-1.558-.463-3.067-.982-4.574-1.208-1.128-.169-2.263-.173-3.298.164-.13.046-.256.095-.38.15-.373.164-.633.342-.805.52-.077.098-.081.105-.087.21-.004.068.031.289.13.571.1.282.256.634.467 1.03.279.524.448 1.063.431 1.618a2.12 2.12.0 01-.499 1.309 1.757 1.757.0 01-.62.51h-.002c-.515.291-1.107.404-1.723.464-.86.083-1.787.026-2.598-.097-.806-.123-1.47-.28-1.948-.555-.444-.256-.79-.547-1.037-.925a2.273 2.273.0 01-.356-1.301c.029-.837.403-1.437.625-1.897.111-.23.191-.433.236-.583.045-.15.044-.25.046-.24-.005-.029-.127-.355-1.015-.741-1.138-.495-2.322-.673-3.533-.668h-.015a9.711 9.711.0 00-.521.016h-.002c-1.163.057-2.35.308-3.541.569.383 1.531.79 2.753.818 4.502-.096 1.297.158 2.114-1.03 2.935-.85.588-1.508.729-2.15.335" style="fill:#3d414d;fill-opacity:1;stroke:none;stroke-width:1.03763;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" transform="translate(-40.698 -95.175)"/><path d="M61.472 101.34v.002c-.3-.003-.603.01-.894.04-.544.055-1.39.165-1.778.306-1.238.364.13 2.344.41 2.913.28.569.285 2.03.14 2.134-.144.103-.375.261-.934.345-.56.084.03-.037-1.589.086-1.62.122-5.506.29-8.265.248-.022.26-.036.521-.097.808-.309 1.442-.63 3.163-.494 4.074.071.473.168.65.414.8.23.14.737.235 1.62-.004.834-.227 1.3-.442 1.887-.456.595-.016 1.555.472 1.965.717.411.245-.03-.008.002.0s.128.05.176.102c.049.053-.276-.523.104.199.379.721.72 3.256.002 4.68-.46.913-1.01 1.49-1.64 1.711-.63.22-1.229.067-1.734-.135-.881-.353-1.584-.7-2.205-.647-1.199 1.94-1.186 4.17-.6 6.602.097.397.212.814.327 1.23 2.68-.556 5.542-1.016 8.337.132 1.064.437 1.73 1.015 1.902 1.857.169.831-.193 1.508-.438 1.986-.122.238-.23.46-.307.642-.07.164-.096.28-.104.324.069.429.309.723.686.945.385.227.89.355 1.35.423.723.104 1.567.152 2.287.086.693-.064 1.032-.338 1.241-.544a2.447 2.447.0 00.303-.437.175.175.0 00.013-.035c-.004-.066-.037-.246-.195-.527-.46-.816-.87-1.595-.817-2.51.028-.476.218-.938.529-1.288.304-.343.698-.586 1.186-.79 1.442-.606 2.96-.609 4.372-.409 1.525.216 2.963.679 4.378 1.083.226-2.09.784-3.9.592-5.77-.058-.565-.287-1.333-.598-1.827-.32-.508-.59-.717-1.036-.642-.648.11-1.472.935-2.707 1.078-.791.092-1.494-.267-1.95-.86-.45-.583-.678-1.335-.78-2.101-.202-1.525.031-3.229.89-4.27.615-.747 1.45-.887 2.15-.74.687.145 1.307.492 1.857.745v-.002c.546.252 1.033.388 1.281.344a.547.547.0 00.353-.188c.113-.124.242-.35.384-.75.604-1.712.206-3.68-.303-5.654-.667.145-1.336.293-2.018.413-1.341.236-2.73.392-4.136.273-.656-.055-1.695-.085-2.58-.476-.442-.195-.903-.514-1.157-1.093-.259-.591-.205-1.313.08-2.014.223-.64 1.082-2.178.692-2.585-.391-.407-1.651-.56-2.554-.571z" style="fill:#3d414d;fil
Relearn
</a>
</div>
<div class=searchbox>
<label for=search-by><i class="fas fa-search"></i></label>
<input data-search-input id=search-by type=search placeholder=Search...>
<span data-search-clear><i class="fas fa-times"></i></span>
</div>
<script src=../../js/lunr.min.js?1634426281></script>
<script src=../../js/auto-complete.js?1634426281></script>
<script>var index_url="../../index.json",root_url="../../",baseUri=root_url.replace(/\/$/,'')</script>
<script src=../../js/search.js?1634426281></script>
</div>
<div class=highlightable>
<ul class=topics>
<li data-nav-id=/basics/ title=Basics class=dd-item><a href=../../basics/><b>1.</b> Basics<i class="fas fa-check read-icon"></i></a><ul>
<li data-nav-id=/basics/migration/ title="What's new" class="dd-item alwaysopen"><a href=../../basics/migration/>What's new<i class="fas fa-check read-icon"></i></a><ul></ul></li>
<li data-nav-id=/basics/requirements/ title=Requirements class="dd-item alwaysopen"><a href=../../basics/requirements/>Requirements<i class="fas fa-check read-icon"></i></a><ul></ul></li>
<li data-nav-id=/basics/installation/ title=Installation class="dd-item alwaysopen"><a href=../../basics/installation/>Installation<i class="fas fa-check read-icon"></i></a><ul></ul></li>
<li data-nav-id=/basics/configuration/ title=Configuration class="dd-item alwaysopen"><a href=../../basics/configuration/>Configuration<i class="fas fa-check read-icon"></i></a><ul></ul></li>
<li data-nav-id=/basics/customization/ title=Customization class="dd-item alwaysopen"><a href=../../basics/customization/>Customization<i class="fas fa-check read-icon"></i></a><ul></ul></li>
<li data-nav-id=/basics/history/ title=History class="dd-item alwaysopen"><a href=../../basics/history/>History<i class="fas fa-check read-icon"></i></a><ul></ul></li></ul></li>
<li data-nav-id=/cont/ title=Content class="dd-item parent"><a href=../../cont/><b>2.</b> Content<i class="fas fa-check read-icon"></i></a><ul>
<li data-nav-id=/cont/pages/ title="Pages organization" class="dd-item alwaysopen"><a href=../../cont/pages/>Pages organization<i class="fas fa-check read-icon"></i></a><ul></ul></li>
<li data-nav-id=/cont/archetypes/ title=Archetypes class=dd-item><a href=../../cont/archetypes/>Archetypes<i class="fas fa-check read-icon"></i></a></li>
<li data-nav-id=/cont/markdown/ title="Markdown syntax" class="dd-item active"><a href=../../cont/markdown/>Markdown syntax<i class="fas fa-check read-icon"></i></a></li>
<li data-nav-id=/cont/syntaxhighlight/ title="Code highlighting" class=dd-item><a href=../../cont/syntaxhighlight/>Code highlighting<i class="fas fa-check read-icon"></i></a></li>
<li data-nav-id=/cont/menushortcuts/ title="Menu extra shortcuts" class=dd-item><a href=../../cont/menushortcuts/>Menu extra shortcuts<i class="fas fa-check read-icon"></i></a></li>
<li data-nav-id=/cont/icons/ title="Icons and logos" class=dd-item><a href=../../cont/icons/>Icons and logos<i class="fas fa-check read-icon"></i></a></li>
<li data-nav-id=/cont/i18n/ title="Multilingual and i18n" class="dd-item alwaysopen"><a href=../../cont/i18n/>Multilingual and i18n<i class="fas fa-check read-icon"></i></a><ul></ul></li>
<li data-nav-id=/cont/tags/ title=Tags class=dd-item><a href=../../cont/tags/>Tags<i class="fas fa-check read-icon"></i></a></li></ul></li>
<li data-nav-id=/shortcodes/ title=Shortcodes class=dd-item><a href=../../shortcodes/><b>3.</b> Shortcodes<i class="fas fa-check read-icon"></i></a><ul>
<li data-nav-id=/shortcodes/attachments/ title=Attachments class=dd-item><a href=../../shortcodes/attachments/>Attachments<i class="fas fa-check read-icon"></i></a></li>
<li data-nav-id=/shortcodes/button/ title=Button class=dd-item><a href=../../shortcodes/button/>Button<i class="fas fa-check read-icon"></i></a></li>
<li data-nav-id=/shortcodes/children/ title=Children class=dd-item><a href=../../shortcodes/children/>Children<i class="fas fa-check read-icon"></i></a><ul>
<li data-nav-id=/shortcodes/children/test/ title="page X" class=dd-item><a href=../../shortcodes/children/test/>page X<i class="fas fa-check read-icon"></i></a></li>
<li data-nav-id=/shortcodes/children/children-1/ title="page 1" class=dd-item><a href=../../shortcodes/children/children-1/>page 1<i class="fas fa-check read-icon"></i></a><ul>
<li data-nav-id=/shortcodes/children/children-1/children-1-1/ title="page 1-1" class=dd-item><a href=../../shortcodes/children/children-1/children-1-1/>page 1-1<i class="fas fa-check read-icon"></i></a><ul>
<li data-nav-id=/shortcodes/children/children-1/children-1-1/children-1-1-2/ title="page 1-1-2" class="dd-item alwaysopen"><a href=../../shortcodes/children/children-1/children-1-1/children-1-1-2/>page 1-1-2<i class="fas fa-check read-icon"></i></a><ul>
<li data-nav-id=/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/ title="page 1-1-2-1" class="dd-item alwaysopen"><a href=../../shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-1/>page 1-1-2-1<i class="fas fa-check read-icon"></i></a><ul></ul></li>
<li data-nav-id=/shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/ title="page 1-1-2-2" class="dd-item alwaysopen"><a href=../../shortcodes/children/children-1/children-1-1/children-1-1-2/children-1-1-2-2/>page 1-1-2-2<i class="fas fa-check read-icon"></i></a><ul></ul></li></ul></li>
<li data-nav-id=/shortcodes/children/children-1/children-1-1/children-1-1-3/ title="page 1-1-3" class="dd-item alwaysopen"><a href=../../shortcodes/children/children-1/children-1-1/children-1-1-3/>page 1-1-3<i class="fas fa-check read-icon"></i></a><ul></ul></li></ul></li></ul></li>
<li data-nav-id=/shortcodes/children/children-2/ title="page 2" class=dd-item><a href=../../shortcodes/children/children-2/>page 2<i class="fas fa-check read-icon"></i></a><ul></ul></li>
<li data-nav-id=/shortcodes/children/children-3/ title="page 3" class=dd-item><a href=../../shortcodes/children/children-3/>page 3<i class="fas fa-check read-icon"></i></a><ul>
<li data-nav-id=/shortcodes/children/children-3/test3/ title="page 3-1" class=dd-item><a href=../../shortcodes/children/children-3/test3/>page 3-1<i class="fas fa-check read-icon"></i></a></li></ul></li></ul></li>
<li data-nav-id=/shortcodes/expand/ title=Expand class=dd-item><a href=../../shortcodes/expand/>Expand<i class="fas fa-check read-icon"></i></a></li>
<li data-nav-id=/shortcodes/include/ title=Include class=dd-item><a href=../../shortcodes/include/>Include<i class="fas fa-check read-icon"></i></a></li>
<li data-nav-id=/shortcodes/mermaid/ title=Mermaid class=dd-item><a href=../../shortcodes/mermaid/>Mermaid<i class="fas fa-check read-icon"></i></a></li>
<li data-nav-id=/shortcodes/notice/ title=Notice class=dd-item><a href=../../shortcodes/notice/>Notice<i class="fas fa-check read-icon"></i></a></li>
<li data-nav-id=/shortcodes/siteparam/ title="Site param" class=dd-item><a href=../../shortcodes/siteparam/>Site param<i class="fas fa-check read-icon"></i></a></li>
<li data-nav-id=/shortcodes/tabs/ title="Tabbed views" class=dd-item><a href=../../shortcodes/tabs/>Tabbed views<i class="fas fa-check read-icon"></i></a></li></ul></li>
</ul>
<div id=shortcuts>
<div class=nav-title>More</div>
<ul>
<li><a class=padding href=../../tags/><i class="fas fa-fw fa-tags"></i> Tags</a></li>
<li><a class=padding href=https://github.com/McShelby/hugo-theme-relearn><i class="fab fa-fw fa-github"></i> GitHub repo</a></li>
<li><a class=padding href=../../showcase><i class="fas fa-fw fa-camera"></i> Showcases</a></li>
<li><a class=padding href=https://gohugo.io/><i class="fas fa-fw fa-bookmark"></i> Hugo Documentation</a></li>
<li><a class=padding href=../../credits><i class="fas fa-fw fa-bullhorn"></i> Credits</a></li>
</ul>
</div>
<div id=prefooter>
<hr>
<ul>
<li>
<a class=padding>
<i class="fas fa-language fa-fw"></i>
<div class=select-style>
<select id=select-language onchange="location=this.value"><option id=en value=https://example.com/cont/markdown/ selected>English</option><option id=pir value=https://example.com/pir/cont/markdown/>Arrr! Pirrrates</option></select><svg id="Capa_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="255" height="255" viewBox="0 0 255 255" style="enable-background:new 0 0 255 255"><g><g id="arrow-drop-down"><polygon points="0,63.75 127.5,191.25 255,63.75"/></g></g></svg>
</div>
</a>
</li>
<li><a class=padding href=# data-clear-history-toggle><i class="fas fa-history fa-fw"></i> Clear History</a></li>
</ul>
</div>
<div id=footer>
<a class=github-button href=https://github.com/McShelby/hugo-theme-relearn/archive/main.zip data-icon=octicon-cloud-download aria-label="Download McShelby/hugo-theme-relearn on GitHub">Download</a>
<a class=github-button href=https://github.com/McShelby/hugo-theme-relearn data-icon=octicon-star data-show-count=true aria-label="Star McShelby/hugo-theme-relearn on GitHub">Star</a>
<a class=github-button href=https://github.com/McShelby/hugo-theme-relearn/fork data-icon=octicon-repo-forked data-show-count=true aria-label="Fork McShelby/hugo-theme-relearn on GitHub">Fork</a>
<p>Built with <a href=https://github.com/McShelby/hugo-theme-relearn><i class="fas fa-heart"></i></a> by <a href=https://gohugo.io/>Hugo</a></p>
<script async defer src=https://buttons.github.io/buttons.js></script>
</div>
</div>
</nav>
<div id=body>
<div id=overlay></div>
<div class="padding highlightable">
<div id=top-bar>
<div id=top-github-link>
<a class=github-link title="Edit this page" href=https://github.com/McShelby/hugo-theme-relearn/edit/main/exampleSite/content/cont/markdown.en.md target=blank>
<i class="fas fa-code-branch"></i>
<span id=top-github-link-text>Edit this page</span>
</a>
</div>
<div id=breadcrumbs>
<span id=sidebar-toggle-span>
<a href=# id=sidebar-toggle data-sidebar-toggle>
<i class="fas fa-bars"></i>
</a>
</span>
<span id=toc-menu><i class="fas fa-list-alt"></i></span>
<ol class=links itemscope itemtype=http://schema.org/BreadcrumbList>
<meta itemprop=itemListOrder content="Descending">
<li itemscope itemtype=https://schema.org/ListItem itemprop=itemListElement><meta itemprop=position content="3"><a itemprop=item href=../../><span itemprop=name>Relearn Theme for Hugo</span></a> > </li>
<li itemscope itemtype=https://schema.org/ListItem itemprop=itemListElement><meta itemprop=position content="2"><a itemprop=item href=../../cont/><span itemprop=name>Content</span></a> > </li>
<li itemscope itemtype=https://schema.org/ListItem itemprop=itemListElement><meta itemprop=position content="1"><a itemprop=item href=../../cont/markdown/ aria-disabled=true><span itemprop=name>Markdown syntax</span></a></li>
</ol>
</div>
<div class=progress>
<div class=wrapper>
<nav id=TableOfContents>
<ul>
<li><a href=#headings>Headings</a></li>
</ul>
<ul>
<li><a href=#h2-heading>h2 Heading</a>
<ul>
<li><a href=#h3-heading>h3 Heading</a></li>
</ul>
</li>
<li><a href=#comments>Comments</a></li>
<li><a href=#horizontal-rules>Horizontal Rules</a></li>
<li><a href=#paragraphs>Paragraphs</a></li>
<li><a href=#text-markers>Text Markers</a>
<ul>
<li><a href=#bold>Bold</a></li>
<li><a href=#italics>Italics</a></li>
<li><a href=#strikethrough>Strikethrough</a></li>
</ul>
</li>
<li><a href=#blockquotes>Blockquotes</a></li>
<li><a href=#lists>Lists</a>
<ul>
<li><a href=#unordered>Unordered</a></li>
<li><a href=#ordered>Ordered</a></li>
</ul>
</li>
<li><a href=#code>Code</a>
<ul>
<li><a href=#inline-code>Inline code</a></li>
<li><a href=#indented-code>Indented code</a></li>
<li><a href=#block-code-fences>Block code &ldquo;fences&rdquo;</a></li>
<li><a href=#syntax-highlighting>Syntax highlighting</a></li>
</ul>
</li>
<li><a href=#tables>Tables</a>
<ul>
<li><a href=#right-aligned-text>Right aligned text</a></li>
<li><a href=#two-tables-adjacent>Two tables adjacent</a></li>
</ul>
</li>
<li><a href=#links>Links</a>
<ul>
<li><a href=#basic-link>Basic link</a></li>
<li><a href=#add-a-tooltip>Add a tooltip</a></li>
<li><a href=#named-anchors>Named Anchors</a></li>
</ul>
</li>
<li><a href=#images>Images</a>
<ul>
<li><a href=#alternative-usage--note-images>Alternative usage : note images</a></li>
<li><a href=#further-image-formatting>Further image formatting</a></li>
</ul>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div id=head-tags>
</div>
<main id=body-inner>
<h1>Markdown syntax</h1>
<p>Let&rsquo;s face it: Writing content for the Web is tiresome. WYSIWYG editors help alleviate this task, but they generally result in horrible code, or worse yet, ugly web pages.</p>
<p><strong>Markdown</strong> is a better way to write <strong>HTML</strong>, without all the complexities and ugliness that usually accompanies it.</p>
<p>Some of the key benefits are:</p>
<ol>
<li>Markdown is simple to learn, with minimal extra characters so it&rsquo;s also quicker to write content.</li>
<li>Less chance of errors when writing in Markdown.</li>
<li>Produces valid XHTML output.</li>
<li>Keeps the content and the visual display separate, so you cannot mess up the look of your site.</li>
<li>Write in any text editor or Markdown application you like.</li>
<li>Markdown is a joy to use!</li>
</ol>
<p>John Gruber, the author of Markdown, puts it like this:</p>
<blockquote>
<p>The overriding design goal for Markdowns formatting syntax is to make it as readable as possible. The idea is that a Markdown-formatted document should be publishable as-is, as plain text, without looking like its been marked up with tags or formatting instructions. While Markdowns syntax has been influenced by several existing text-to-HTML filters, the single biggest source of inspiration for Markdowns syntax is the format of plain text email.
<cite>John Gruber</cite></p>
</blockquote>
<p>Without further delay, let us go over the main elements of Markdown and what the resulting HTML looks like:</p>
<div class="notices info">
<div class=label>Info</div><p><i class="fas fa-bookmark"></i> Bookmark this page and the <a href=https://commonmark.org/help/>official Commonmark reference</a> for easy future reference!</p>
</div>
<h2 id=headings>Headings</h2>
<p>Headings from <code>h1</code> through <code>h6</code> are constructed with a <code>#</code> for each level:</p>
<div class=highlight><pre tabindex=0 style=color:#e2e4e5;background-color:#282a36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-markdown data-lang=markdown><span style=font-weight:700># h1 Heading
</span><span style=font-weight:700></span><span style=font-weight:700>## h2 Heading
</span><span style=font-weight:700>### h3 Heading
</span><span style=font-weight:700>#### h4 Heading
</span><span style=font-weight:700>##### h5 Heading
</span><span style=font-weight:700>###### h6 Heading
</span></code></pre></div><p>Renders to:</p>
<h1 id=h1-heading>h1 Heading</h1>
<h2 id=h2-heading>h2 Heading</h2>
<h3 id=h3-heading>h3 Heading</h3>
<h4 id=h4-heading>h4 Heading</h4>
<h5 id=h5-heading>h5 Heading</h5>
<h6 id=h6-heading>h6 Heading</h6>
<p>HTML:</p>
<div class=highlight><pre tabindex=0 style=color:#e2e4e5;background-color:#282a36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-html data-lang=html>&lt;<span style=color:#ff6ac1>h1</span>&gt;h1 Heading&lt;/<span style=color:#ff6ac1>h1</span>&gt;
&lt;<span style=color:#ff6ac1>h2</span>&gt;h2 Heading&lt;/<span style=color:#ff6ac1>h2</span>&gt;
&lt;<span style=color:#ff6ac1>h3</span>&gt;h3 Heading&lt;/<span style=color:#ff6ac1>h3</span>&gt;
&lt;<span style=color:#ff6ac1>h4</span>&gt;h4 Heading&lt;/<span style=color:#ff6ac1>h4</span>&gt;
&lt;<span style=color:#ff6ac1>h5</span>&gt;h5 Heading&lt;/<span style=color:#ff6ac1>h5</span>&gt;
&lt;<span style=color:#ff6ac1>h6</span>&gt;h6 Heading&lt;/<span style=color:#ff6ac1>h6</span>&gt;
</code></pre></div><h2 id=comments>Comments</h2>
<p>Comments should be HTML compatible</p>
<div class=highlight><pre tabindex=0 style=color:#e2e4e5;background-color:#282a36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-html data-lang=html><span style=color:#78787e>&lt;!--
</span><span style=color:#78787e>This is a comment
</span><span style=color:#78787e>--&gt;</span>
</code></pre></div><p>Comment below should <strong>NOT</strong> be seen:</p>
<h2 id=horizontal-rules>Horizontal Rules</h2>
<p>The HTML <code>&lt;hr></code> element is for creating a &ldquo;thematic break&rdquo; between paragraph-level elements. In Markdown, you can create a <code>&lt;hr></code> with <code>---</code> - three consecutive dashes</p>
<p>renders to:</p>
<hr>
<h2 id=paragraphs>Paragraphs</h2>
<p>Any text not starting with a special sign is written as normal, plain text and will be wrapped within <code>&lt;p>&lt;/p></code> tags in the rendered HTML.</p>
<p>So this body copy:</p>
<div class=highlight><pre tabindex=0 style=color:#e2e4e5;background-color:#282a36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-markdown data-lang=markdown>Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus. Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad.
</code></pre></div><p>renders to this HTML:</p>
<div class=highlight><pre tabindex=0 style=color:#e2e4e5;background-color:#282a36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-html data-lang=html>&lt;<span style=color:#ff6ac1>p</span>&gt;Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus. Et legere ocurreret pri, animal tacimates complectitur ad cum. Cu eum inermis inimicus efficiendi. Labore officiis his ex, soluta officiis concludaturque ei qui, vide sensibus vim ad.&lt;/<span style=color:#ff6ac1>p</span>&gt;
</code></pre></div><h2 id=text-markers>Text Markers</h2>
<h3 id=bold>Bold</h3>
<p>For emphasizing a snippet of text with a heavier font-weight.</p>
<p>The following snippet of text is <strong>rendered as bold text</strong>.</p>
<div class=highlight><pre tabindex=0 style=color:#e2e4e5;background-color:#282a36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-markdown data-lang=markdown>**rendered as bold text**
</code></pre></div><p>renders to:</p>
<p><strong>rendered as bold text</strong></p>
<p>and this HTML</p>
<div class=highlight><pre tabindex=0 style=color:#e2e4e5;background-color:#282a36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-html data-lang=html>&lt;<span style=color:#ff6ac1>strong</span>&gt;rendered as bold text&lt;/<span style=color:#ff6ac1>strong</span>&gt;
</code></pre></div><h3 id=italics>Italics</h3>
<p>For emphasizing a snippet of text with italics.</p>
<p>The following snippet of text is <em>rendered as italicized text</em>.</p>
<div class=highlight><pre tabindex=0 style=color:#e2e4e5;background-color:#282a36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-markdown data-lang=markdown>_rendered as italicized text_
</code></pre></div><p>renders to:</p>
<p><em>rendered as italicized text</em></p>
<p>and this HTML:</p>
<div class=highlight><pre tabindex=0 style=color:#e2e4e5;background-color:#282a36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-html data-lang=html>&lt;<span style=color:#ff6ac1>em</span>&gt;rendered as italicized text&lt;/<span style=color:#ff6ac1>em</span>&gt;
</code></pre></div><h3 id=strikethrough>Strikethrough</h3>
<p>In GFM (GitHub flavored Markdown) you can do strikethroughs.</p>
<div class=highlight><pre tabindex=0 style=color:#e2e4e5;background-color:#282a36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-markdown data-lang=markdown>~~Strike through this text.~~
</code></pre></div><p>Which renders to:</p>
<p><del>Strike through this text.</del></p>
<p>HTML:</p>
<div class=highlight><pre tabindex=0 style=color:#e2e4e5;background-color:#282a36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-html data-lang=html>&lt;<span style=color:#ff6ac1>del</span>&gt;Strike through this text.&lt;/<span style=color:#ff6ac1>del</span>&gt;
</code></pre></div><h2 id=blockquotes>Blockquotes</h2>
<p>For quoting blocks of content from another source within your document.</p>
<p>Add <code>></code> before any text you want to quote.</p>
<div class=highlight><pre tabindex=0 style=color:#e2e4e5;background-color:#282a36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-markdown data-lang=markdown><span style=color:#ff6ac1>&gt; </span><span style=text-decoration:underline>**Fusion Drive** combines a hard drive with a flash storage (solid-state drive) and presents it as a single logical volume with the space of both drives combined.
</span></code></pre></div><p>Renders to:</p>
<blockquote>
<p><strong>Fusion Drive</strong> combines a hard drive with a flash storage (solid-state drive) and presents it as a single logical volume with the space of both drives combined.</p>
</blockquote>
<p>and this HTML:</p>
<div class=highlight><pre tabindex=0 style=color:#e2e4e5;background-color:#282a36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-html data-lang=html>&lt;<span style=color:#ff6ac1>blockquote</span>&gt;
&lt;<span style=color:#ff6ac1>p</span>&gt;&lt;<span style=color:#ff6ac1>strong</span>&gt;Fusion Drive&lt;/<span style=color:#ff6ac1>strong</span>&gt; combines a hard drive with a flash storage (solid-state drive) and presents it as a single logical volume with the space of both drives combined.&lt;/<span style=color:#ff6ac1>p</span>&gt;
&lt;/<span style=color:#ff6ac1>blockquote</span>&gt;
</code></pre></div><p>Blockquotes can also be nested:</p>
<div class=highlight><pre tabindex=0 style=color:#e2e4e5;background-color:#282a36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-markdown data-lang=markdown><span style=color:#ff6ac1>&gt; </span><span style=text-decoration:underline>Donec massa lacus, ultricies a ullamcorper in, fermentum sed augue. Nunc augue augue, aliquam non hendrerit ac, commodo vel nisi.
</span><span style=text-decoration:underline></span><span style=color:#ff6ac1>&gt;
</span><span style=color:#ff6ac1></span><span style=text-decoration:underline>&gt; &gt; Sed adipiscing elit vitae augue consectetur a gravida nunc vehicula. Donec auctor odio non est accumsan facilisis. Aliquam id turpis in dolor tincidunt mollis ac eu diam.
</span><span style=text-decoration:underline></span><span style=color:#ff6ac1>&gt;
</span><span style=color:#ff6ac1></span><span style=text-decoration:underline>&gt; Mauris sit amet ligula egestas, feugiat metus tincidunt, luctus libero. Donec congue finibus tempor. Vestibulum aliquet sollicitudin erat, ut aliquet purus posuere luctus.
</span></code></pre></div><p>Renders to:</p>
<blockquote>
<p>Donec massa lacus, ultricies a ullamcorper in, fermentum sed augue. Nunc augue augue, aliquam non hendrerit ac, commodo vel nisi.</p>
<blockquote>
<p>Sed adipiscing elit vitae augue consectetur a gravida nunc vehicula. Donec auctor odio non est accumsan facilisis. Aliquam id turpis in dolor tincidunt mollis ac eu diam.</p>
</blockquote>
<p>Mauris sit amet ligula egestas, feugiat metus tincidunt, luctus libero. Donec congue finibus tempor. Vestibulum aliquet sollicitudin erat, ut aliquet purus posuere luctus.</p>
</blockquote>
<h2 id=lists>Lists</h2>
<h3 id=unordered>Unordered</h3>
<p>A list of items in which the order of the items does not explicitly matter.</p>
<p>You may use any of the following symbols to denote bullets for each list item:</p>
<div class=highlight><pre tabindex=0 style=color:#e2e4e5;background-color:#282a36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-markdown data-lang=markdown><span style=color:#ff6ac1>*</span> valid bullet
<span style=color:#ff6ac1>-</span> valid bullet
+ valid bullet
</code></pre></div><p>For example</p>
<div class=highlight><pre tabindex=0 style=color:#e2e4e5;background-color:#282a36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-markdown data-lang=markdown>+ Lorem ipsum dolor sit amet
+ Consectetur adipiscing elit
+ Integer molestie lorem at massa
+ Facilisis in pretium nisl aliquet
+ Nulla volutpat aliquam velit
<span style=color:#ff6ac1>-</span> Phasellus iaculis neque
<span style=color:#ff6ac1>-</span> Purus sodales ultricies
<span style=color:#ff6ac1>-</span> Vestibulum laoreet porttitor sem
<span style=color:#ff6ac1>-</span> Ac tristique libero volutpat at
+ Faucibus porta lacus fringilla vel
+ Aenean sit amet erat nunc
+ Eget porttitor lorem
</code></pre></div><p>Renders to:</p>
<ul>
<li>Lorem ipsum dolor sit amet</li>
<li>Consectetur adipiscing elit</li>
<li>Integer molestie lorem at massa</li>
<li>Facilisis in pretium nisl aliquet</li>
<li>Nulla volutpat aliquam velit
<ul>
<li>Phasellus iaculis neque</li>
<li>Purus sodales ultricies</li>
<li>Vestibulum laoreet porttitor sem</li>
<li>Ac tristique libero volutpat at</li>
</ul>
</li>
<li>Faucibus porta lacus fringilla vel</li>
<li>Aenean sit amet erat nunc</li>
<li>Eget porttitor lorem</li>
</ul>
<p>And this HTML</p>
<div class=highlight><pre tabindex=0 style=color:#e2e4e5;background-color:#282a36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-html data-lang=html>&lt;<span style=color:#ff6ac1>ul</span>&gt;
&lt;<span style=color:#ff6ac1>li</span>&gt;Lorem ipsum dolor sit amet&lt;/<span style=color:#ff6ac1>li</span>&gt;
&lt;<span style=color:#ff6ac1>li</span>&gt;Consectetur adipiscing elit&lt;/<span style=color:#ff6ac1>li</span>&gt;
&lt;<span style=color:#ff6ac1>li</span>&gt;Integer molestie lorem at massa&lt;/<span style=color:#ff6ac1>li</span>&gt;
&lt;<span style=color:#ff6ac1>li</span>&gt;Facilisis in pretium nisl aliquet&lt;/<span style=color:#ff6ac1>li</span>&gt;
&lt;<span style=color:#ff6ac1>li</span>&gt;Nulla volutpat aliquam velit
&lt;<span style=color:#ff6ac1>ul</span>&gt;
&lt;<span style=color:#ff6ac1>li</span>&gt;Phasellus iaculis neque&lt;/<span style=color:#ff6ac1>li</span>&gt;
&lt;<span style=color:#ff6ac1>li</span>&gt;Purus sodales ultricies&lt;/<span style=color:#ff6ac1>li</span>&gt;
&lt;<span style=color:#ff6ac1>li</span>&gt;Vestibulum laoreet porttitor sem&lt;/<span style=color:#ff6ac1>li</span>&gt;
&lt;<span style=color:#ff6ac1>li</span>&gt;Ac tristique libero volutpat at&lt;/<span style=color:#ff6ac1>li</span>&gt;
&lt;/<span style=color:#ff6ac1>ul</span>&gt;
&lt;/<span style=color:#ff6ac1>li</span>&gt;
&lt;<span style=color:#ff6ac1>li</span>&gt;Faucibus porta lacus fringilla vel&lt;/<span style=color:#ff6ac1>li</span>&gt;
&lt;<span style=color:#ff6ac1>li</span>&gt;Aenean sit amet erat nunc&lt;/<span style=color:#ff6ac1>li</span>&gt;
&lt;<span style=color:#ff6ac1>li</span>&gt;Eget porttitor lorem&lt;/<span style=color:#ff6ac1>li</span>&gt;
&lt;/<span style=color:#ff6ac1>ul</span>&gt;
</code></pre></div><h3 id=ordered>Ordered</h3>
<p>A list of items in which the order of items does explicitly matter.</p>
<div class=highlight><pre tabindex=0 style=color:#e2e4e5;background-color:#282a36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-markdown data-lang=markdown><span style=color:#ff6ac1>1.</span> Lorem ipsum dolor sit amet
<span style=color:#ff6ac1>4.</span> Consectetur adipiscing elit
<span style=color:#ff6ac1>2.</span> Integer molestie lorem at massa
<span style=color:#ff6ac1>8.</span> Facilisis in pretium nisl aliquet
<span style=color:#ff6ac1>4.</span> Nulla volutpat aliquam velit
<span style=color:#ff6ac1>99.</span> Faucibus porta lacus fringilla vel
<span style=color:#ff6ac1>21.</span> Aenean sit amet erat nunc
<span style=color:#ff6ac1>6.</span> Eget porttitor lorem
</code></pre></div><p>Renders to:</p>
<ol>
<li>Lorem ipsum dolor sit amet</li>
<li>Consectetur adipiscing elit</li>
<li>Integer molestie lorem at massa</li>
<li>Facilisis in pretium nisl aliquet</li>
<li>Nulla volutpat aliquam velit</li>
<li>Faucibus porta lacus fringilla vel</li>
<li>Aenean sit amet erat nunc</li>
<li>Eget porttitor lorem</li>
</ol>
<p>And this HTML:</p>
<div class=highlight><pre tabindex=0 style=color:#e2e4e5;background-color:#282a36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-html data-lang=html>&lt;<span style=color:#ff6ac1>ol</span>&gt;
&lt;<span style=color:#ff6ac1>li</span>&gt;Lorem ipsum dolor sit amet&lt;/<span style=color:#ff6ac1>li</span>&gt;
&lt;<span style=color:#ff6ac1>li</span>&gt;Consectetur adipiscing elit&lt;/<span style=color:#ff6ac1>li</span>&gt;
&lt;<span style=color:#ff6ac1>li</span>&gt;Integer molestie lorem at massa&lt;/<span style=color:#ff6ac1>li</span>&gt;
&lt;<span style=color:#ff6ac1>li</span>&gt;Facilisis in pretium nisl aliquet&lt;/<span style=color:#ff6ac1>li</span>&gt;
&lt;<span style=color:#ff6ac1>li</span>&gt;Nulla volutpat aliquam velit&lt;/<span style=color:#ff6ac1>li</span>&gt;
&lt;<span style=color:#ff6ac1>li</span>&gt;Faucibus porta lacus fringilla vel&lt;/<span style=color:#ff6ac1>li</span>&gt;
&lt;<span style=color:#ff6ac1>li</span>&gt;Aenean sit amet erat nunc&lt;/<span style=color:#ff6ac1>li</span>&gt;
&lt;<span style=color:#ff6ac1>li</span>&gt;Eget porttitor lorem&lt;/<span style=color:#ff6ac1>li</span>&gt;
&lt;/<span style=color:#ff6ac1>ol</span>&gt;
</code></pre></div>
<div class="notices tip">
<div class=label>Tip</div><p>If you just use <code>1.</code> for each number, Markdown will automatically number each item. For example:</p>
</div>
<div class=highlight><pre tabindex=0 style=color:#e2e4e5;background-color:#282a36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-markdown data-lang=markdown><span style=color:#ff6ac1>1.</span> Lorem ipsum dolor sit amet
<span style=color:#ff6ac1>1.</span> Consectetur adipiscing elit
<span style=color:#ff6ac1>1.</span> Integer molestie lorem at massa
<span style=color:#ff6ac1>1.</span> Facilisis in pretium nisl aliquet
<span style=color:#ff6ac1>1.</span> Nulla volutpat aliquam velit
<span style=color:#ff6ac1>1.</span> Faucibus porta lacus fringilla vel
<span style=color:#ff6ac1>1.</span> Aenean sit amet erat nunc
<span style=color:#ff6ac1>1.</span> Eget porttitor lorem
</code></pre></div><p>Renders to:</p>
<ol>
<li>Lorem ipsum dolor sit amet</li>
<li>Consectetur adipiscing elit</li>
<li>Integer molestie lorem at massa</li>
<li>Facilisis in pretium nisl aliquet</li>
<li>Nulla volutpat aliquam velit</li>
<li>Faucibus porta lacus fringilla vel</li>
<li>Aenean sit amet erat nunc</li>
<li>Eget porttitor lorem</li>
</ol>
<h2 id=code>Code</h2>
<h3 id=inline-code>Inline code</h3>
<p>Wrap inline snippets of code with <code>`</code>.</p>
<div class=highlight><pre tabindex=0 style=color:#e2e4e5;background-color:#282a36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-markdown data-lang=markdown>In this example, <span style=color:#5af78e>`&lt;div&gt;&lt;/div&gt;`</span> should be wrapped as <span style=font-style:italic>**code**</span>.
</code></pre></div><p>Renders to:</p>
<p>In this example, <code>&lt;div>&lt;/div></code> should be wrapped as <strong>code</strong>.</p>
<p>HTML:</p>
<div class=highlight><pre tabindex=0 style=color:#e2e4e5;background-color:#282a36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-html data-lang=html>&lt;<span style=color:#ff6ac1>p</span>&gt;In this example, &lt;<span style=color:#ff6ac1>code</span>&gt;&amp;lt;div&amp;gt;&amp;lt;/div&amp;gt;&lt;/<span style=color:#ff6ac1>code</span>&gt; should be wrapped as &lt;<span style=color:#ff6ac1>strong</span>&gt;code&lt;/<span style=color:#ff6ac1>strong</span>&gt;.&lt;/<span style=color:#ff6ac1>p</span>&gt;
</code></pre></div><h3 id=indented-code>Indented code</h3>
<p>Or indent several lines of code by at least two spaces, as in:</p>
<div class=highlight><pre tabindex=0 style=color:#e2e4e5;background-color:#282a36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-markdown data-lang=markdown> // Some comments
line 1 of code
line 2 of code
line 3 of code
</code></pre></div><p>Renders to:</p>
<pre><code>// Some comments
line 1 of code
line 2 of code
line 3 of code
</code></pre>
<p>HTML:</p>
<div class=highlight><pre tabindex=0 style=color:#e2e4e5;background-color:#282a36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-html data-lang=html>&lt;<span style=color:#ff6ac1>pre</span>&gt;
&lt;<span style=color:#ff6ac1>code</span>&gt;
// Some comments
line 1 of code
line 2 of code
line 3 of code
&lt;/<span style=color:#ff6ac1>code</span>&gt;
&lt;/<span style=color:#ff6ac1>pre</span>&gt;
</code></pre></div><h3 id=block-code-fences>Block code &ldquo;fences&rdquo;</h3>
<p>Use &ldquo;fences&rdquo; <code>```</code> to block in multiple lines of code.</p>
<div class=highlight><pre tabindex=0 style=color:#e2e4e5;background-color:#282a36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-plaintext data-lang=plaintext>```
Sample text here...
```
</code></pre></div><p>HTML:</p>
<div class=highlight><pre tabindex=0 style=color:#e2e4e5;background-color:#282a36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-html data-lang=html>&lt;<span style=color:#ff6ac1>pre</span>&gt;
&lt;<span style=color:#ff6ac1>code</span>&gt;Sample text here...&lt;/<span style=color:#ff6ac1>code</span>&gt;
&lt;/<span style=color:#ff6ac1>pre</span>&gt;
</code></pre></div><h3 id=syntax-highlighting>Syntax highlighting</h3>
<p>GFM, or &ldquo;GitHub Flavored Markdown&rdquo; also supports syntax highlighting. To activate it, usually you simply add the file extension of the language you want to use directly after the first code &ldquo;fence&rdquo;, <code>```js</code>, and syntax highlighting will automatically be applied in the rendered HTML.</p>
<p>See <a href=../../cont/syntaxhighlight/>Code Highlighting</a> for additional documentation.</p>
<p>For example, to apply syntax highlighting to JavaScript code:</p>
<div class=highlight><pre tabindex=0 style=color:#e2e4e5;background-color:#282a36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-plaintext data-lang=plaintext>```js
grunt.initConfig({
assemble: {
options: {
assets: &#39;docs/assets&#39;,
data: &#39;src/data/*.{json,yml}&#39;,
helpers: &#39;src/custom-helpers.js&#39;,
partials: [&#39;src/partials/**/*.{hbs,md}&#39;]
},
pages: {
options: {
layout: &#39;default.hbs&#39;
},
files: {
&#39;./&#39;: [&#39;src/templates/pages/index.hbs&#39;]
}
}
}
};
```
</code></pre></div><p>Renders to:</p>
<div class=highlight><pre tabindex=0 style=color:#e2e4e5;background-color:#282a36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-js data-lang=js>grunt.initConfig({
assemble<span style=color:#ff6ac1>:</span> {
options<span style=color:#ff6ac1>:</span> {
assets<span style=color:#ff6ac1>:</span> <span style=color:#5af78e>&#39;docs/assets&#39;</span>,
data<span style=color:#ff6ac1>:</span> <span style=color:#5af78e>&#39;src/data/*.{json,yml}&#39;</span>,
helpers<span style=color:#ff6ac1>:</span> <span style=color:#5af78e>&#39;src/custom-helpers.js&#39;</span>,
partials<span style=color:#ff6ac1>:</span> [<span style=color:#5af78e>&#39;src/partials/**/*.{hbs,md}&#39;</span>]
},
pages<span style=color:#ff6ac1>:</span> {
options<span style=color:#ff6ac1>:</span> {
layout<span style=color:#ff6ac1>:</span> <span style=color:#5af78e>&#39;default.hbs&#39;</span>
},
files<span style=color:#ff6ac1>:</span> {
<span style=color:#5af78e>&#39;./&#39;</span><span style=color:#ff6ac1>:</span> [<span style=color:#5af78e>&#39;src/templates/pages/index.hbs&#39;</span>]
}
}
}
};
</code></pre></div><h2 id=tables>Tables</h2>
<p>Tables are created by adding pipes as dividers between each cell, and by adding a line of dashes (also separated by bars) beneath the header. Note that the pipes do not need to be vertically aligned.</p>
<div class=highlight><pre tabindex=0 style=color:#e2e4e5;background-color:#282a36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-markdown data-lang=markdown>| Option | Description |
| ------ | ----------- |
| data | path to data files to supply the data that will be passed into templates. |
| engine | engine to be used for processing templates. Handlebars is the default. |
| ext | extension to be used for dest files. |
</code></pre></div><p>Renders to:</p>
<table>
<thead>
<tr>
<th>Option</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>data</td>
<td>path to data files to supply the data that will be passed into templates.</td>
</tr>
<tr>
<td>engine</td>
<td>engine to be used for processing templates. Handlebars is the default.</td>
</tr>
<tr>
<td>ext</td>
<td>extension to be used for dest files.</td>
</tr>
</tbody>
</table>
<p>And this HTML:</p>
<div class=highlight><pre tabindex=0 style=color:#e2e4e5;background-color:#282a36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-html data-lang=html>&lt;<span style=color:#ff6ac1>table</span>&gt;
&lt;<span style=color:#ff6ac1>tr</span>&gt;
&lt;<span style=color:#ff6ac1>th</span>&gt;Option&lt;/<span style=color:#ff6ac1>th</span>&gt;
&lt;<span style=color:#ff6ac1>th</span>&gt;Description&lt;/<span style=color:#ff6ac1>th</span>&gt;
&lt;/<span style=color:#ff6ac1>tr</span>&gt;
&lt;<span style=color:#ff6ac1>tr</span>&gt;
&lt;<span style=color:#ff6ac1>td</span>&gt;data&lt;/<span style=color:#ff6ac1>td</span>&gt;
&lt;<span style=color:#ff6ac1>td</span>&gt;path to data files to supply the data that will be passed into templates.&lt;/<span style=color:#ff6ac1>td</span>&gt;
&lt;/<span style=color:#ff6ac1>tr</span>&gt;
&lt;<span style=color:#ff6ac1>tr</span>&gt;
&lt;<span style=color:#ff6ac1>td</span>&gt;engine&lt;/<span style=color:#ff6ac1>td</span>&gt;
&lt;<span style=color:#ff6ac1>td</span>&gt;engine to be used for processing templates. Handlebars is the default.&lt;/<span style=color:#ff6ac1>td</span>&gt;
&lt;/<span style=color:#ff6ac1>tr</span>&gt;
&lt;<span style=color:#ff6ac1>tr</span>&gt;
&lt;<span style=color:#ff6ac1>td</span>&gt;ext&lt;/<span style=color:#ff6ac1>td</span>&gt;
&lt;<span style=color:#ff6ac1>td</span>&gt;extension to be used for dest files.&lt;/<span style=color:#ff6ac1>td</span>&gt;
&lt;/<span style=color:#ff6ac1>tr</span>&gt;
&lt;/<span style=color:#ff6ac1>table</span>&gt;
</code></pre></div><h3 id=right-aligned-text>Right aligned text</h3>
<p>Adding a colon on the right side of the dashes below any heading will right align text for that column.</p>
<div class=highlight><pre tabindex=0 style=color:#e2e4e5;background-color:#282a36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-markdown data-lang=markdown>| Option | Description |
| ------:| -----------:|
| data | path to data files to supply the data that will be passed into templates. |
| engine | engine to be used for processing templates. Handlebars is the default. |
| ext | extension to be used for dest files. |
</code></pre></div><table>
<thead>
<tr>
<th style=text-align:right>Option</th>
<th style=text-align:right>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td style=text-align:right>data</td>
<td style=text-align:right>path to data files to supply the data that will be passed into templates.</td>
</tr>
<tr>
<td style=text-align:right>engine</td>
<td style=text-align:right>engine to be used for processing templates. Handlebars is the default.</td>
</tr>
<tr>
<td style=text-align:right>ext</td>
<td style=text-align:right>extension to be used for dest files.</td>
</tr>
</tbody>
</table>
<h3 id=two-tables-adjacent>Two tables adjacent</h3>
<table>
<thead>
<tr>
<th>Option</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>ext</td>
<td>extension to be used for dest files.</td>
</tr>
</tbody>
</table>
<table>
<thead>
<tr>
<th>Option</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>ext</td>
<td>extension to be used for dest files.</td>
</tr>
</tbody>
</table>
<h2 id=links>Links</h2>
<h3 id=basic-link>Basic link</h3>
<div class=highlight><pre tabindex=0 style=color:#e2e4e5;background-color:#282a36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-markdown data-lang=markdown>[<span style=color:#ff6ac1>Assemble</span>](<span style=color:#57c7ff>http://assemble.io</span>)
</code></pre></div><p>Renders to (hover over the link, there is no tooltip):</p>
<p><a href=http://assemble.io>Assemble</a></p>
<p>HTML:</p>
<div class=highlight><pre tabindex=0 style=color:#e2e4e5;background-color:#282a36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-html data-lang=html>&lt;<span style=color:#ff6ac1>a</span> <span style=color:#57c7ff>href</span><span style=color:#ff6ac1>=</span><span style=color:#5af78e>&#34;http://assemble.io&#34;</span>&gt;Assemble&lt;/<span style=color:#ff6ac1>a</span>&gt;
</code></pre></div><h3 id=add-a-tooltip>Add a tooltip</h3>
<div class=highlight><pre tabindex=0 style=color:#e2e4e5;background-color:#282a36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-markdown data-lang=markdown>[<span style=color:#ff6ac1>Upstage</span>](<span style=color:#57c7ff>https://github.com/upstage/ &#34;Visit Upstage!&#34;</span>)
</code></pre></div><p>Renders to (hover over the link, there should be a tooltip):</p>
<p><a href=https://github.com/upstage/ title="Visit Upstage!">Upstage</a></p>
<p>HTML:</p>
<div class=highlight><pre tabindex=0 style=color:#e2e4e5;background-color:#282a36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-html data-lang=html>&lt;<span style=color:#ff6ac1>a</span> <span style=color:#57c7ff>href</span><span style=color:#ff6ac1>=</span><span style=color:#5af78e>&#34;https://github.com/upstage/&#34;</span> <span style=color:#57c7ff>title</span><span style=color:#ff6ac1>=</span><span style=color:#5af78e>&#34;Visit Upstage!&#34;</span>&gt;Upstage&lt;/<span style=color:#ff6ac1>a</span>&gt;
</code></pre></div><h3 id=named-anchors>Named Anchors</h3>
<p>Named anchors enable you to jump to the specified anchor point on the same page. For example, each of these chapters:</p>
<div class=highlight><pre tabindex=0 style=color:#e2e4e5;background-color:#282a36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-markdown data-lang=markdown><span style=font-weight:700># Table of Contents
</span><span style=font-weight:700></span> <span style=color:#ff6ac1>*</span> [<span style=color:#ff6ac1>Chapter 1</span>](<span style=color:#57c7ff>#chapter-1</span>)
<span style=color:#ff6ac1>*</span> [<span style=color:#ff6ac1>Chapter 2</span>](<span style=color:#57c7ff>#chapter-2</span>)
<span style=color:#ff6ac1>*</span> [<span style=color:#ff6ac1>Chapter 3</span>](<span style=color:#57c7ff>#chapter-3</span>)
</code></pre></div><p>will jump to these sections:</p>
<div class=highlight><pre tabindex=0 style=color:#e2e4e5;background-color:#282a36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-markdown data-lang=markdown><span style=font-weight:700>## Chapter 1 &lt;a id=&#34;chapter-1&#34;&gt;&lt;/a&gt;
</span><span style=font-weight:700></span>Content for chapter one.
<span style=font-weight:700>## Chapter 2 &lt;a id=&#34;chapter-2&#34;&gt;&lt;/a&gt;
</span><span style=font-weight:700></span>Content for chapter one.
<span style=font-weight:700>## Chapter 3 &lt;a id=&#34;chapter-3&#34;&gt;&lt;/a&gt;
</span><span style=font-weight:700></span>Content for chapter one.
</code></pre></div><p><strong>NOTE</strong> that specific placement of the anchor tag seems to be arbitrary. They are placed inline here since it seems to be unobtrusive, and it works.</p>
<h2 id=images>Images</h2>
<p>Images have a similar syntax to links but include a preceding exclamation point.</p>
<div class=highlight><pre tabindex=0 style=color:#e2e4e5;background-color:#282a36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-markdown data-lang=markdown>![<span style=color:#ff6ac1>Minion</span>](<span style=color:#57c7ff>https://octodex.github.com/images/minion.png</span>)
</code></pre></div><p><img src=https://octodex.github.com/images/minion.png alt=Minion></p>
<p>or</p>
<div class=highlight><pre tabindex=0 style=color:#e2e4e5;background-color:#282a36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-markdown data-lang=markdown>![<span style=color:#ff6ac1>Alt text</span>](<span style=color:#57c7ff>https://octodex.github.com/images/stormtroopocat.jpg &#34;The Stormtroopocat&#34;</span>)
</code></pre></div><p><img src=https://octodex.github.com/images/stormtroopocat.jpg alt="Alt text" title="The Stormtroopocat"></p>
<p>Like links, Images also have a footnote style syntax</p>
<h3 id=alternative-usage--note-images>Alternative usage : note images</h3>
<div class=highlight><pre tabindex=0 style=color:#e2e4e5;background-color:#282a36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-markdown data-lang=markdown>![Alt text][id]
</code></pre></div><p><img src=https://octodex.github.com/images/dojocat.jpg alt="Alt text" title="The Dojocat"></p>
<p>With a reference later in the document defining the URL location:</p>
<pre><code>[id]: https://octodex.github.com/images/dojocat.jpg &quot;The Dojocat&quot;
</code></pre>
<h3 id=further-image-formatting>Further image formatting</h3>
<p>The Hugo Markdown parser supports additional non-standard functionality.</p>
<h4 id=resizing-image>Resizing image</h4>
<p>Add HTTP parameters <code>width</code> and/or <code>height</code> to the link image to resize the image. Values are CSS values (default is <code>auto</code>).</p>
<div class=highlight><pre tabindex=0 style=color:#e2e4e5;background-color:#282a36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-markdown data-lang=markdown>![<span style=color:#ff6ac1>Minion</span>](<span style=color:#57c7ff>https://octodex.github.com/images/minion.png?width=20pc</span>)
</code></pre></div><p><img src="https://octodex.github.com/images/minion.png?width=20pc" alt=Minion></p>
<p><img src="https://octodex.github.com/images/stormtroopocat.png?width=20pc" alt=stormtroopocat></p>
<div class=highlight><pre tabindex=0 style=color:#e2e4e5;background-color:#282a36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-markdown data-lang=markdown>![<span style=color:#ff6ac1>Minion</span>](<span style=color:#57c7ff>https://octodex.github.com/images/minion.png?height=50px</span>)
</code></pre></div><p><img src="https://octodex.github.com/images/minion.png?height=50px" alt=Minion></p>
<div class=highlight><pre tabindex=0 style=color:#e2e4e5;background-color:#282a36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-markdown data-lang=markdown>![<span style=color:#ff6ac1>Minion</span>](<span style=color:#57c7ff>https://octodex.github.com/images/minion.png?height=50px&amp;width=300px</span>)
</code></pre></div><p><img src="https://octodex.github.com/images/minion.png?height=50px&width=300px" alt=Minion></p>
<h4 id=add-css-classes>Add CSS classes</h4>
<p>Add a HTTP <code>classes</code> parameter to the link image to add CSS classes. <code>shadow</code>and <code>border</code> are available but you could define other ones.</p>
<div class=highlight><pre tabindex=0 style=color:#e2e4e5;background-color:#282a36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-markdown data-lang=markdown>![<span style=color:#ff6ac1>stormtroopocat</span>](<span style=color:#57c7ff>https://octodex.github.com/images/stormtroopocat.jpg?classes=shadow</span>)
</code></pre></div><p><img src="https://octodex.github.com/images/stormtroopocat.jpg?width=40pc&classes=shadow" alt=stormtroopocat></p>
<div class=highlight><pre tabindex=0 style=color:#e2e4e5;background-color:#282a36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-markdown data-lang=markdown>![<span style=color:#ff6ac1>stormtroopocat</span>](<span style=color:#57c7ff>https://octodex.github.com/images/stormtroopocat.jpg?classes=border</span>)
</code></pre></div><p><img src="https://octodex.github.com/images/stormtroopocat.jpg?width=40pc&classes=border" alt=stormtroopocat></p>
<div class=highlight><pre tabindex=0 style=color:#e2e4e5;background-color:#282a36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-markdown data-lang=markdown>![<span style=color:#ff6ac1>stormtroopocat</span>](<span style=color:#57c7ff>https://octodex.github.com/images/stormtroopocat.jpg?classes=border,shadow</span>)
</code></pre></div><p><img src="https://octodex.github.com/images/stormtroopocat.jpg?width=40pc&classes=border,shadow" alt=stormtroopocat></p>
<h4 id=lightbox>Lightbox</h4>
<p>Add a HTTP <code>featherlight</code> parameter to the link image to disable lightbox. By default lightbox is enabled using the featherlight.js plugin. You can disable this by defining <code>featherlight</code> to <code>false</code>.</p>
<div class=highlight><pre tabindex=0 style=color:#e2e4e5;background-color:#282a36;-moz-tab-size:4;-o-tab-size:4;tab-size:4><code class=language-markdown data-lang=markdown>![<span style=color:#ff6ac1>Minion</span>](<span style=color:#57c7ff>https://octodex.github.com/images/minion.png?featherlight=false</span>)
</code></pre></div><p><img src="https://octodex.github.com/images/minion.png?featherlight=false" alt=Minion></p>
<footer class=footline>
</footer>
</main>
</div>
<div id=navigation>
<a class="nav nav-prev" href=../../cont/archetypes/ title=Archetypes><i class="fa fa-chevron-left"></i></a>
<a class="nav nav-next" href=../../cont/syntaxhighlight/ title="Code highlighting"><i class="fa fa-chevron-right"></i></a>
</div>
</div>
<div style=left:-1000px;overflow:scroll;position:absolute;top:-1000px;border:none;box-sizing:content-box;height:200px;margin:0;padding:0;width:200px>
<div style=border:none;box-sizing:content-box;height:200px;margin:0;padding:0;width:200px></div>
</div>
<script src=../../js/clipboard.min.js?1634426281></script>
<script src=../../js/perfect-scrollbar.min.js?1634426281></script>
<script src=../../js/perfect-scrollbar.jquery.min.js?1634426281></script>
<script src=../../js/jquery.svg.pan.zoom.js?1634426281></script>
<script src=../../js/featherlight.min.js?1634426281></script>
<script src=../../js/modernizr.custom-3.6.0.js?1634426281></script>
<script src=../../js/mermaid.min.js?1634426281></script>
<script>typeof mermaid!='undefined'&&mermaid.mermaidAPI.initialize(Object.assign({securityLevel:"antiscript"},JSON.parse('{ "startOnLoad": true }'),{startOnLoad:!1}))</script>
<script src=../../js/relearn.js?1634426281></script>
</body>
</html>