2022-04-02 13:30:16 +00:00
<!DOCTYPE html>
2022-11-01 01:10:49 +00:00
< html lang = "en" dir = "ltr" >
2022-04-02 13:30:16 +00:00
< head >
< meta charset = "utf-8" >
< meta name = "viewport" content = "height=device-height, width=device-width, initial-scale=1.0, minimum-scale=1.0" >
2022-11-24 23:10:06 +00:00
< meta name = "generator" content = "Hugo 0.107.0" >
2022-11-29 19:41:45 +00:00
< meta name = "generator" content = "Relearn 5.7.0+tip" >
2022-04-02 13:30:16 +00:00
< meta name = "description" content = "Documentation for Hugo Relearn Theme" >
< meta name = "author" content = "Sören Weber" >
< title > Markdown syntax :: Hugo Relearn Theme< / title >
2022-11-15 06:35:08 +00:00
< link href = "https://McShelby.github.io/hugo-theme-relearn/cont/markdown/index.html" rel = "canonical" type = "text/html" title = "Markdown syntax :: Hugo Relearn Theme" >
2022-11-06 00:38:34 +00:00
< link href = "../../cont/markdown/index.xml" rel = "alternate" type = "application/rss+xml" title = "Markdown syntax :: Hugo Relearn Theme" >
2022-12-02 15:21:29 +00:00
< link href = "../../images/logo.svg?1669994483" rel = "icon" type = "image/svg+xml" >
2022-07-15 13:20:02 +00:00
<!-- https://github.com/filamentgroup/loadCSS/blob/master/README.md#how - to - use -->
2022-12-02 15:21:29 +00:00
< link href = "../../css/fontawesome-all.min.css?1669994484" rel = "stylesheet" media = "print" onload = "this.media='all';this.onload=null;" > < noscript > < link href = "../../css/fontawesome-all.min.css?1669994484" rel = "stylesheet" > < / noscript >
< link href = "../../css/featherlight.min.css?1669994484" rel = "stylesheet" media = "print" onload = "this.media='all';this.onload=null;" > < noscript > < link href = "../../css/featherlight.min.css?1669994484" rel = "stylesheet" > < / noscript >
< link href = "../../css/auto-complete.css?1669994484" rel = "stylesheet" media = "print" onload = "this.media='all';this.onload=null;" > < noscript > < link href = "../../css/auto-complete.css?1669994484" rel = "stylesheet" > < / noscript >
< link href = "../../css/perfect-scrollbar.min.css?1669994484" rel = "stylesheet" >
< link href = "../../css/nucleus.css?1669994484" rel = "stylesheet" >
< link href = "../../css/fonts.css?1669994484" rel = "stylesheet" media = "print" onload = "this.media='all';this.onload=null;" > < noscript > < link href = "../../css/fonts.css?1669994484" rel = "stylesheet" > < / noscript >
< link href = "../../css/theme.css?1669994484" rel = "stylesheet" >
< link href = "../../css/theme-relearn-light.css?1669994484" rel = "stylesheet" id = "variant-style" >
< link href = "../../css/ie.css?1669994484" rel = "stylesheet" >
< link href = "../../css/variant.css?1669994484" rel = "stylesheet" >
< link href = "../../css/print.css?1669994484" rel = "stylesheet" media = "print" >
< link href = "../../css/format-print.css?1669994484" rel = "stylesheet" >
< script src = "../../js/url.js?1669994484" > < / script >
< script src = "../../js/variant.js?1669994484" > < / script >
2022-04-02 13:30:16 +00:00
< script >
// hack to let hugo tell us how to get to the root when using relativeURLs, it needs to be called *url= for it to do its magic:
// https://github.com/gohugoio/hugo/blob/145b3fcce35fbac25c7033c91c1b7ae6d1179da8/transform/urlreplacers/absurlreplacer.go#L72
2022-11-05 23:35:48 +00:00
window.index_js_url="../../index.search.js";
var root_url="../../";
2022-04-02 13:30:16 +00:00
var baseUri=root_url.replace(/\/$/, '');
// translations
window.T_Copy_to_clipboard = 'Copy to clipboard';
window.T_Copied_to_clipboard = 'Copied to clipboard!';
window.T_Copy_link_to_clipboard = 'Copy link to clipboard';
window.T_Link_copied_to_clipboard = 'Copied link to clipboard!';
2022-11-17 21:13:11 +00:00
window.T_No_results_found = 'No results found for \u0022{0}\u0022';
window.T_N_results_found = '{1} results found for \u0022{0}\u0022';
2022-04-02 13:30:16 +00:00
// some further base stuff
var baseUriFull='https:\/\/McShelby.github.io\/hugo-theme-relearn/';
2022-07-14 20:20:11 +00:00
window.variants & & variants.init( [ 'relearn-light', 'relearn-dark', 'learn', 'neon', 'blue', 'green', 'red' ] );
2022-04-02 13:30:16 +00:00
< / script >
2022-12-02 15:21:29 +00:00
< script src = "../../js/jquery.min.js?1669994484" defer > < / script >
2022-12-02 15:05:54 +00:00
< style >
#body img.bg-white {
background-color: white;
}
< / style >
2022-04-02 13:30:16 +00:00
< / head >
2022-11-15 06:35:08 +00:00
< body class = "mobile-support print disableInlineCopyToClipboard" data-url = "../../cont/markdown/index.html" >
2022-04-02 13:30:16 +00:00
< div id = "body" class = "default-animation" >
< div id = "sidebar-overlay" > < / div >
< div id = "toc-overlay" > < / div >
2022-11-07 19:58:08 +00:00
< nav id = "topbar" class = "highlightable" dir = "ltr" >
2022-04-02 13:30:16 +00:00
< div >
< div id = "breadcrumbs" >
< span id = "sidebar-toggle-span" >
2022-10-08 20:51:04 +00:00
< a href = "#" id = "sidebar-toggle" title = 'Menu (CTRL+ALT+n)' > < i class = "fas fa-bars fa-fw" > < / i > < / a >
2022-04-02 13:30:16 +00:00
< / span >
< ol class = "links" itemscope itemtype = "http://schema.org/BreadcrumbList" >
2022-11-05 23:35:48 +00:00
< li itemscope itemtype = "https://schema.org/ListItem" itemprop = "itemListElement" > < a itemprop = "item" href = "../../index.html" > < span itemprop = "name" > Hugo Relearn Theme< / span > < / a > < meta itemprop = "position" content = "1" > > < / li >
< li itemscope itemtype = "https://schema.org/ListItem" itemprop = "itemListElement" > < a itemprop = "item" href = "../../cont/index.html" > < span itemprop = "name" > Content< / span > < / a > < meta itemprop = "position" content = "2" > > < / li >
2022-10-02 22:25:49 +00:00
< li itemscope itemtype = "https://schema.org/ListItem" itemprop = "itemListElement" > < span itemprop = "name" > Markdown syntax< / span > < meta itemprop = "position" content = "3" > < / li >
2022-04-02 13:30:16 +00:00
< / ol >
< / div >
< / div >
< / nav >
2022-07-05 22:16:52 +00:00
< main id = "body-inner" class = "highlightable default" tabindex = "-1" >
2022-04-02 13:30:16 +00:00
< div class = "flex-block-wrapper" >
< div id = "head-tags" >
< / div >
2022-11-07 19:58:08 +00:00
< article class = "default" >
2022-11-13 21:34:47 +00:00
< h1 id = "markdown-syntax" > Markdown syntax< / h1 >
2022-07-05 22:16:52 +00:00
2022-12-02 15:05:54 +00:00
< p > Let’ 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 >
2022-04-02 13:30:16 +00:00
< 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’ s also quicker to write content.< / li >
< li > Less chance of errors when writing in Markdown.< / li >
2022-12-02 15:05:54 +00:00
< li > Produces valid HTML output.< / li >
2022-04-02 13:30:16 +00:00
< 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 Markdown’ ’ ’ ’
< 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 >
2022-12-02 15:05:54 +00:00
< div class = "box notices cstyle tip" >
< div class = "box-label" > < i class = "fa-fw fas fa-lightbulb" > < / i > Tip< / div >
2022-12-01 00:38:08 +00:00
< div class = "box-content" >
2022-04-02 13:30:16 +00:00
< 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 >
< / div >
2022-12-02 15:05:54 +00:00
< h2 id = "paragraphs" > Paragraphs< / h2 >
< p > In Markdown your content usually spans the whole available document width. This is called a block. Blocks are always separated by whitespace to their adjacent blocks in the resulting document.< / p >
< p > Any text not starting with a special sign is written as normal, plain text paragraph block and must be separated to its adjacent blocks by empty lines.< / p >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < span class = "line" > < span class = "cl" > Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus.
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > 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.
< / span > < / span > < / code > < / pre > < / div >
< div class = "box notices cstyle secondary" >
< div class = "box-label" > < i class = "fa-fw fas fa-eye" > < / i > Result< / div >
< div class = "box-content" >
< p > Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus.< / p >
< p > 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.< / p >
< / div >
< / div >
2022-04-02 13:30:16 +00:00
< h2 id = "headings" > Headings< / h2 >
2022-12-02 15:05:54 +00:00
< p > A good idea is to structure your content using headings and subheadings. HTML-headings from < code > h1< / code > through < code > h6< / code > are constructed with a < code > #< / code > for each level.< / p >
< p > In Hugo you usually don’ t use < code > h1< / code > as this is generated by your theme and you should only have one such element in a document.< / p >
2022-04-02 13:30:16 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < span class = "line" > < span class = "cl" > < span class = "gh" > # h1 Heading
2022-12-02 15:05:54 +00:00
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "gh" > < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "gu" > ## h2 Heading
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "gu" > < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "gu" > ### h3 Heading
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "gu" > < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "gu" > #### h4 Heading
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "gu" > < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "gu" > ##### h5 Heading
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "gu" > < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "gu" > ###### h6 Heading
< / span > < / span > < / span > < / code > < / pre > < / div >
< div class = "box notices cstyle secondary" >
< div class = "box-label" > < i class = "fa-fw fas fa-eye" > < / i > Result< / div >
< div class = "box-content" >
2022-04-02 13:30:16 +00:00
< 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 >
2022-12-02 15:05:54 +00:00
< / div >
< / div >
2022-04-02 13:30:16 +00:00
< h2 id = "horizontal-rules" > Horizontal Rules< / h2 >
2022-12-02 15:05:54 +00:00
< p > To further structure your content you can add horizontal rules. They create a “ thematic break” between paragraph blocks. In Markdown, you can create it with three consecutive dashes < code > ---< / code > .< / p >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < span class = "line" > < span class = "cl" > Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus.
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > ---
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > 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.
< / span > < / span > < / code > < / pre > < / div >
< div class = "box notices cstyle secondary" >
< div class = "box-label" > < i class = "fa-fw fas fa-eye" > < / i > Result< / div >
< div class = "box-content" >
< p > Lorem ipsum dolor sit amet, graecis denique ei vel, at duo primis mandamus.< / p >
2022-04-02 13:30:16 +00:00
< hr >
2022-12-02 15:05:54 +00:00
< p > 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.< / p >
< / div >
< / div >
< h2 id = "text-markers" > Text Markers< / h2 >
2022-04-02 13:30:16 +00:00
< h3 id = "bold" > Bold< / h3 >
2022-12-02 15:05:54 +00:00
< p > You can show importance of a snippet of text with a heavier font-weight by enclosing it with two asterisks < code > **< / code > .< / p >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < span class = "line" > < span class = "cl" > I am rendered with < span class = "gs" > **bold text**< / span >
< / span > < / span > < / code > < / pre > < / div >
< div class = "box notices cstyle secondary" >
< div class = "box-label" > < i class = "fa-fw fas fa-eye" > < / i > Result< / div >
< div class = "box-content" >
< p > I am rendered with < strong > bold text< / strong > < / p >
< / div >
< / div >
< h3 id = "italics" > Italics< / h3 >
< p > You can emphasize a snippet of text with italics by enclosing it with underscores < code > _< / code > .< / p >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < span class = "line" > < span class = "cl" > I am rendered with < span class = "ge" > _italicized text_< / span >
< / span > < / span > < / code > < / pre > < / div >
< div class = "box notices cstyle secondary" >
< div class = "box-label" > < i class = "fa-fw fas fa-eye" > < / i > Result< / div >
< div class = "box-content" >
< p > I am rendered with < em > italicized text< / em > < / p >
< / div >
< / div >
< h3 id = "strikethrough" > Strikethrough< / h3 >
2022-12-02 15:21:29 +00:00
< p > In GFM (GitHub Flavored Markdown) you can do strikethroughs by enclosing text with two tildes < code > ~~< / code > .< / p >
2022-12-02 15:05:54 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < span class = "line" > < span class = "cl" > ~~Strike through this text~~
< / span > < / span > < / code > < / pre > < / div >
< div class = "box notices cstyle secondary" >
< div class = "box-label" > < i class = "fa-fw fas fa-eye" > < / i > Result< / div >
< div class = "box-content" >
< p > < del > Strike through this text< / del > < / p >
< / div >
< / div >
< h2 id = "text-substitution" > Text substitution< / h2 >
< p > This Markdown dialect supports an extension to combine multiple punctuation characters to single typographic entities. This will only be applied to text outside of code blocks or inline code.< / p >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < span class = "line" > < span class = "cl" > Double quotes < span class = "sb" > `" `< / span > and single quotes < span class = "sb" > `' `< / span > of enclosed text are replaced by < span class = "ge" > **< / span > " double curly quotes" ** and < span class = "ge" > **< / span > ' single curly quotes' **.
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > Double dashes < span class = "sb" > `--`< / span > and triple dashes < span class = "sb" > `---`< / span > are replaced by en-dash < span class = "ge" > **< / span > --** and em-dash < span class = "ge" > **< / span > ---** entities.
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > Double arrows pointing left < span class = "sb" > `< < `< / span > or right < span class = "sb" > `> > `< / span > are replaced by arrow < span class = "ge" > **< / span > < span class = "err" > < < < / span > ** and < span class = "ge" > **< / span > > > ** entities.
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > Three consecutive dots < span class = "sb" > `...`< / span > are replaced by an ellipsis < span class = "ge" > **< / span > ...** entity.
< / span > < / span > < / code > < / pre > < / div >
< div class = "box notices cstyle secondary" >
< div class = "box-label" > < i class = "fa-fw fas fa-eye" > < / i > Result< / div >
< div class = "box-content" >
< p > Double quotes < code > " < / code > and single quotes < code > '< / code > of enclosed text are replaced by < strong > “ double curly quotes” < / strong > and < strong > ‘ single curly quotes’ < / strong > .< / p >
< p > Double dashes < code > --< / code > and triple dashes < code > ---< / code > are replaced by en-dash < strong > – < / strong > and em-dash < strong > — < / strong > entities.< / p >
< p > Double arrows pointing left < code > < < < / code > or right < code > > > < / code > are replaced by arrow < strong > « < / strong > and < strong > » < / strong > entities.< / p >
< p > Three consecutive dots < code > ...< / code > are replaced by an ellipsis < strong > … < / strong > entity.< / p >
< / div >
< / div >
2022-04-02 13:30:16 +00:00
< h2 id = "lists" > Lists< / h2 >
< h3 id = "unordered" > Unordered< / h3 >
2022-12-02 15:05:54 +00:00
< p > You can write a list of items in which the order of the items does not explicitly matter.< / p >
< p > It is possible to nest lists by indenting an item for the next sublevel.< / p >
< p > You may use any of < code > -< / code > , < code > *< / code > or < code > +< / code > to denote bullets for each list item but should not switch between those symbols inside one whole list.< / p >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < span class = "line" > < span class = "cl" > < span class = "k" > -< / span > Lorem ipsum dolor sit amet
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "k" > -< / span > Consectetur adipiscing elit
2022-04-02 13:30:16 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "k" > -< / span > Vestibulum laoreet porttitor sem
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "k" > -< / span > Ac tristique libero volutpat at
2022-12-02 15:05:54 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "k" > -< / span > Nulla volutpat aliquam velit
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "k" > -< / span > Phasellus iaculis neque
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "k" > -< / span > Purus sodales ultricies
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "k" > -< / span > Faucibus porta lacus fringilla vel
< / span > < / span > < / code > < / pre > < / div >
< div class = "box notices cstyle secondary" >
< div class = "box-label" > < i class = "fa-fw fas fa-eye" > < / i > Result< / div >
< div class = "box-content" >
2022-04-02 13:30:16 +00:00
< ul >
< li > Lorem ipsum dolor sit amet< / li >
2022-12-02 15:05:54 +00:00
< li > Consectetur adipiscing elit
< ul >
< li > Vestibulum laoreet porttitor sem< / li >
< li > Ac tristique libero volutpat at< / li >
< / ul >
< / li >
2022-04-02 13:30:16 +00:00
< li > Nulla volutpat aliquam velit
< ul >
< li > Phasellus iaculis neque< / li >
< li > Purus sodales ultricies< / li >
< / ul >
< / li >
< li > Faucibus porta lacus fringilla vel< / li >
< / ul >
2022-12-02 15:05:54 +00:00
< / div >
< / div >
< h3 id = "ordered" > Ordered< / h3 >
< p > You can create a list of items in which the order of items does explicitly matter.< / p >
< p > It is possible to nest lists by indenting an item for the next sublevel.< / p >
< p > Markdown will automatically number each of your items consecutively. This means, the order number you are providing is irrelevant.< / p >
2022-04-02 13:30:16 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < span class = "line" > < span class = "cl" > < span class = "k" > 1.< / span > Lorem ipsum dolor sit amet
2022-12-02 15:05:54 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "k" > 3.< / span > Consectetur adipiscing elit
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "k" > 1.< / span > Integer molestie lorem at massa
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "k" > 7.< / span > Facilisis in pretium nisl aliquet
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "k" > 99.< / span > Nulla volutpat aliquam velit
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "k" > 1.< / span > Faucibus porta lacus fringilla vel
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "k" > 1.< / span > Aenean sit amet erat nunc
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "k" > 17.< / span > Eget porttitor lorem
< / span > < / span > < / code > < / pre > < / div >
< div class = "box notices cstyle secondary" >
< div class = "box-label" > < i class = "fa-fw fas fa-eye" > < / i > Result< / div >
< div class = "box-content" >
2022-04-02 13:30:16 +00:00
< ol >
< li > Lorem ipsum dolor sit amet< / li >
2022-12-02 15:05:54 +00:00
< li > Consectetur adipiscing elit
< ol >
2022-04-02 13:30:16 +00:00
< li > Integer molestie lorem at massa< / li >
< li > Facilisis in pretium nisl aliquet< / li >
2022-12-02 15:05:54 +00:00
< / ol >
< / li >
< li > Nulla volutpat aliquam velit
< ol >
2022-04-02 13:30:16 +00:00
< li > Faucibus porta lacus fringilla vel< / li >
< li > Aenean sit amet erat nunc< / li >
2022-12-02 15:05:54 +00:00
< / ol >
< / li >
2022-04-02 13:30:16 +00:00
< li > Eget porttitor lorem< / li >
< / ol >
2022-12-02 15:05:54 +00:00
< / div >
< / div >
< h3 id = "tasks" > Tasks< / h3 >
2022-12-02 15:21:29 +00:00
< p > In GFM (GitHub Flavored Markdown) you can add task lists resulting in checked or unchecked non-clickable items< / p >
2022-12-02 15:05:54 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < span class = "line" > < span class = "cl" > < span class = "k" > - [x]< / span > Basic Test
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "k" > - [ ]< / span > More Tests
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "k" > - [x]< / span > View
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "k" > - [x]< / span > Hear
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "k" > - [ ]< / span > Smell
2022-04-02 13:30:16 +00:00
< / span > < / span > < / code > < / pre > < / div >
2022-12-02 15:05:54 +00:00
< div class = "box notices cstyle secondary" >
< div class = "box-label" > < i class = "fa-fw fas fa-eye" > < / i > Result< / div >
2022-12-01 00:38:08 +00:00
< div class = "box-content" >
2022-12-02 15:05:54 +00:00
< ul >
< li > < input checked = "" disabled = "" type = "checkbox" > Basic Test< / li >
< li > < input disabled = "" type = "checkbox" > More Tests
< ul >
< li > < input checked = "" disabled = "" type = "checkbox" > View< / li >
< li > < input checked = "" disabled = "" type = "checkbox" > Hear< / li >
< li > < input disabled = "" type = "checkbox" > Smell< / li >
< / ul >
< / li >
< / ul >
< / div >
< / div >
< h3 id = "defintions" > Defintions< / h3 >
< p > This Markdown dialect supports an extension to add defintion lists. Definition lists are made of terms and definitions of these terms, much like in a dictionary.< / p >
< p > A definition list in Markdown Extra is made of a single-line term followed by a colon and the definition for that term. You can also associate more than one term to a definition.< / p >
< p > If you add empty lines around the definition terms, additional vertical space will be generated. Also multiple paragraphs are possible< / p >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < span class = "line" > < span class = "cl" > Apple
< / span > < / span > < span class = "line" > < span class = "cl" > : Pomaceous fruit of plants of the genus Malus in the family Rosaceae.
< / span > < / span > < span class = "line" > < span class = "cl" > : An American computer company.
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > Orange
< / span > < / span > < span class = "line" > < span class = "cl" > : The fruit of an evergreen tree of the genus Citrus.
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > You can make juice out of it.
< / span > < / span > < span class = "line" > < span class = "cl" > : A telecommunication company.
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > You can' t make juice out of it.
< / span > < / span > < / code > < / pre > < / div >
< div class = "box notices cstyle secondary" >
< div class = "box-label" > < i class = "fa-fw fas fa-eye" > < / i > Result< / div >
< div class = "box-content" >
< dl >
< dt > Apple< / dt >
< dd > Pomaceous fruit of plants of the genus Malus in the family Rosaceae.< / dd >
< dd > An American computer company.< / dd >
< dt > Orange< / dt >
< dd > The fruit of an evergreen tree of the genus Citrus.
< p > You can make juice out of it.< / p >
< / dd >
< dd > A telecommunication company.
< p > You can’ t make juice out of it.< / p >
< / dd >
< / dl >
2022-04-02 13:30:16 +00:00
< / div >
< / div >
< h2 id = "code" > Code< / h2 >
2022-12-02 15:05:54 +00:00
< h3 id = "inline-code" > Inline Code< / h3 >
< p > Inline snippets of code can be wrapped with backticks < code > `< / code > .< / p >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < span class = "line" > < span class = "cl" > In this example, < span class = "sb" > `< div> < /div> `< / span > is marked as code.
< / span > < / span > < / code > < / pre > < / div >
< div class = "box notices cstyle secondary" >
< div class = "box-label" > < i class = "fa-fw fas fa-eye" > < / i > Result< / div >
< div class = "box-content" >
< p > In this example, < code > < div> < /div> < / code > is marked as code.< / p >
< / div >
< / div >
< h3 id = "indented-code-block" > Indented Code Block< / h3 >
< p > A simple code block can be generated by indenting several lines of code by at least two spaces.< / p >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < span class = "line" > < span class = "cl" > Be impressed by my advanced code:
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > // Some comments
2022-04-02 13:30:16 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > line 1 of code
< / span > < / span > < span class = "line" > < span class = "cl" > line 2 of code
< / span > < / span > < span class = "line" > < span class = "cl" > line 3 of code
2022-12-02 15:05:54 +00:00
< / span > < / span > < / code > < / pre > < / div >
< div class = "box notices cstyle secondary" >
< div class = "box-label" > < i class = "fa-fw fas fa-eye" > < / i > Result< / div >
< div class = "box-content" >
< p > Be impressed by my advanced code:< / p >
2022-04-02 13:30:16 +00:00
< pre > < code > // Some comments
line 1 of code
line 2 of code
line 3 of code
< / code > < / pre >
2022-12-02 15:05:54 +00:00
< / div >
< / div >
< h3 id = "fenced-code-block" > Fenced Code Block< / h3 >
< p > If you want to gain more control of your code block you can enclose your code by at least three backticks < code > ```< / code > a so called fence.< / p >
< p > In GFM (GitHub Flavored Markdown) you can also add a language specifier directly after the opening fence, < code > ```js< / code > , and syntax highlighting will automatically be applied according to the selected language in the rendered HTML.< / p >
2022-11-05 23:35:48 +00:00
< p > See < a href = "../../cont/syntaxhighlight/" > Code Highlighting< / a > for additional documentation.< / p >
2022-04-02 13:30:16 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-plaintext" data-lang = "plaintext" > < span class = "line" > < span class = "cl" > ```js
< / span > < / span > < span class = "line" > < span class = "cl" > grunt.initConfig({
< / span > < / span > < span class = "line" > < span class = "cl" > assemble: {
< / span > < / span > < span class = "line" > < span class = "cl" > options: {
< / span > < / span > < span class = "line" > < span class = "cl" > assets: ' docs/assets' ,
< / span > < / span > < span class = "line" > < span class = "cl" > data: ' src/data/*.{json,yml}' ,
< / span > < / span > < span class = "line" > < span class = "cl" > helpers: ' src/custom-helpers.js' ,
< / span > < / span > < span class = "line" > < span class = "cl" > partials: [' src/partials/**/*.{hbs,md}' ]
< / span > < / span > < span class = "line" > < span class = "cl" > },
< / span > < / span > < span class = "line" > < span class = "cl" > pages: {
< / span > < / span > < span class = "line" > < span class = "cl" > options: {
< / span > < / span > < span class = "line" > < span class = "cl" > layout: ' default.hbs'
< / span > < / span > < span class = "line" > < span class = "cl" > },
< / span > < / span > < span class = "line" > < span class = "cl" > files: {
< / span > < / span > < span class = "line" > < span class = "cl" > ' ./' : [' src/templates/pages/index.hbs' ]
< / span > < / span > < span class = "line" > < span class = "cl" > }
< / span > < / span > < span class = "line" > < span class = "cl" > }
< / span > < / span > < span class = "line" > < span class = "cl" > }
< / span > < / span > < span class = "line" > < span class = "cl" > };
< / span > < / span > < span class = "line" > < span class = "cl" > ```
2022-12-02 15:05:54 +00:00
< / span > < / span > < / code > < / pre > < / div >
< div class = "box notices cstyle secondary" >
< div class = "box-label" > < i class = "fa-fw fas fa-eye" > < / i > Result< / div >
< div class = "box-content" >
2022-04-02 13:30:16 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-js" data-lang = "js" > < span class = "line" > < span class = "cl" > < span class = "nx" > grunt< / span > < span class = "p" > .< / span > < span class = "nx" > initConfig< / span > < span class = "p" > ({< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > assemble< / span > < span class = "o" > :< / span > < span class = "p" > {< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > options< / span > < span class = "o" > :< / span > < span class = "p" > {< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > assets< / span > < span class = "o" > :< / span > < span class = "s1" > ' docs/assets' < / span > < span class = "p" > ,< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > data< / span > < span class = "o" > :< / span > < span class = "s1" > ' src/data/*.{json,yml}' < / span > < span class = "p" > ,< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > helpers< / span > < span class = "o" > :< / span > < span class = "s1" > ' src/custom-helpers.js' < / span > < span class = "p" > ,< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > partials< / span > < span class = "o" > :< / span > < span class = "p" > [< / span > < span class = "s1" > ' src/partials/**/*.{hbs,md}' < / span > < span class = "p" > ]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > },< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > pages< / span > < span class = "o" > :< / span > < span class = "p" > {< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > options< / span > < span class = "o" > :< / span > < span class = "p" > {< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > layout< / span > < span class = "o" > :< / span > < span class = "s1" > ' default.hbs' < / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > },< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "nx" > files< / span > < span class = "o" > :< / span > < span class = "p" > {< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "s1" > ' ./' < / span > < span class = "o" > :< / span > < span class = "p" > [< / span > < span class = "s1" > ' src/templates/pages/index.hbs' < / span > < span class = "p" > ]< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > }< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > }< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > }< / span >
< / span > < / span > < span class = "line" > < span class = "cl" > < span class = "p" > };< / span >
2022-12-02 15:05:54 +00:00
< / span > < / span > < / code > < / pre > < / div > < / div >
< / div >
< h2 id = "tables" > Tables< / h2 >
2022-12-02 15:21:29 +00:00
< p > In GFM (GitHub Flavored Markdown) you can create tables 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 >
2022-04-02 13:30:16 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < span class = "line" > < span class = "cl" > | Option | Description |
< / span > < / span > < span class = "line" > < span class = "cl" > | ------ | ----------- |
< / span > < / span > < span class = "line" > < span class = "cl" > | data | path to data files to supply the data that will be passed into templates. |
< / span > < / span > < span class = "line" > < span class = "cl" > | engine | engine to be used for processing templates. Handlebars is the default. |
< / span > < / span > < span class = "line" > < span class = "cl" > | ext | extension to be used for dest files. |
2022-12-02 15:05:54 +00:00
< / span > < / span > < / code > < / pre > < / div >
< div class = "box notices cstyle secondary" >
< div class = "box-label" > < i class = "fa-fw fas fa-eye" > < / i > Result< / div >
< div class = "box-content" >
2022-04-02 13:30:16 +00:00
< 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 >
2022-12-02 15:05:54 +00:00
< / div >
< / div >
< h3 id = "aligned-columns" > Aligned Columns< / h3 >
< p > Adding a colon on the left and/or right side of the dashes below any heading will align the text for that column accordingly.< / p >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < span class = "line" > < span class = "cl" > | Option | Number | Description |
< / span > < / span > < span class = "line" > < span class = "cl" > | ------:|:------:|:----------- |
< / span > < / span > < span class = "line" > < span class = "cl" > | data | 1 | path to data files to supply the data that will be passed into templates. |
< / span > < / span > < span class = "line" > < span class = "cl" > | engine | 2 | engine to be used for processing templates. Handlebars is the default. |
< / span > < / span > < span class = "line" > < span class = "cl" > | ext | 3 | extension to be used for dest files. |
< / span > < / span > < / code > < / pre > < / div >
< div class = "box notices cstyle secondary" >
< div class = "box-label" > < i class = "fa-fw fas fa-eye" > < / i > Result< / div >
< div class = "box-content" >
< table >
2022-04-02 13:30:16 +00:00
< thead >
< tr >
< th style = "text-align:right" > Option< / th >
2022-12-02 15:05:54 +00:00
< th style = "text-align:center" > Number< / th >
< th style = "text-align:left" > Description< / th >
2022-04-02 13:30:16 +00:00
< / tr >
< / thead >
< tbody >
< tr >
< td style = "text-align:right" > data< / td >
2022-12-02 15:05:54 +00:00
< td style = "text-align:center" > 1< / td >
< td style = "text-align:left" > path to data files to supply the data that will be passed into templates.< / td >
2022-04-02 13:30:16 +00:00
< / tr >
< tr >
< td style = "text-align:right" > engine< / td >
2022-12-02 15:05:54 +00:00
< td style = "text-align:center" > 2< / td >
< td style = "text-align:left" > engine to be used for processing templates. Handlebars is the default.< / td >
2022-04-02 13:30:16 +00:00
< / tr >
< tr >
< td style = "text-align:right" > ext< / td >
2022-12-02 15:05:54 +00:00
< td style = "text-align:center" > 3< / td >
< td style = "text-align:left" > extension to be used for dest files.< / td >
2022-04-02 13:30:16 +00:00
< / tr >
< / tbody >
< / table >
2022-12-02 15:05:54 +00:00
< / div >
< / div >
< h2 id = "blockquotes" > Blockquotes< / h2 >
< p > For quoting blocks of content from another source within your document add < code > > < / code > before any text you want to quote.< / p >
< p > Blockquotes can also be nested.< / p >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < span class = "line" > < span class = "cl" > < span class = "k" > > < / span > < span class = "ge" > Donec massa lacus, ultricies a ullamcorper in, fermentum sed augue. Nunc augue augue, aliquam non hendrerit ac, commodo vel nisi.
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "ge" > < / span > < span class = "k" > >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "k" > < / span > < span class = "ge" > > > 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 > < / span > < span class = "line" > < span class = "cl" > < span class = "ge" > < / span > < span class = "k" > >
< / span > < / span > < / span > < span class = "line" > < span class = "cl" > < span class = "k" > < / span > < span class = "ge" > > Mauris sit amet ligula egestas, feugiat metus tincidunt, luctus libero. Donec congue finibus tempor. Vestibulum aliquet sollicitudin erat, ut aliquet purus posuere luctus.
< / span > < / span > < / span > < / code > < / pre > < / div >
< div class = "box notices cstyle secondary" >
< div class = "box-label" > < i class = "fa-fw fas fa-eye" > < / i > Result< / div >
< div class = "box-content" >
< 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 >
< / div >
< / div >
2022-04-02 13:30:16 +00:00
< h2 id = "links" > Links< / h2 >
2022-12-02 15:05:54 +00:00
< h3 id = "autolink" > Autolink< / h3 >
< p > In GFM (GitHub Flavored Markdown) absolute URLs will automatically be converted into a link.< / p >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < span class = "line" > < span class = "cl" > This is a link to https://example.com.
< / span > < / span > < / code > < / pre > < / div >
< div class = "box notices cstyle secondary" >
< div class = "box-label" > < i class = "fa-fw fas fa-eye" > < / i > Result< / div >
< div class = "box-content" >
< p > This is a link to < a href = "https://example.com" > https://example.com< / a > .< / p >
< / div >
< / div >
< h3 id = "basic-link" > Basic Link< / h3 >
< p > You can explicitly define links in case you want to use non-absolute URLs or want to give different text.< / p >
2022-04-02 13:30:16 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < span class = "line" > < span class = "cl" > [< span class = "nt" > Assemble< / span > ](< span class = "na" > http://assemble.io< / span > )
2022-12-02 15:05:54 +00:00
< / span > < / span > < / code > < / pre > < / div >
< div class = "box notices cstyle secondary" >
< div class = "box-label" > < i class = "fa-fw fas fa-eye" > < / i > Result< / div >
< div class = "box-content" >
2022-04-02 13:30:16 +00:00
< p > < a href = "http://assemble.io" > Assemble< / a > < / p >
2022-12-02 15:05:54 +00:00
< / div >
< / div >
< h3 id = "link-with-tooltip" > Link with Tooltip< / h3 >
< p > For even further information, you can add an additional text, displayed in a tooltip on hovering over the link.< / p >
2022-04-02 13:30:16 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < span class = "line" > < span class = "cl" > [< span class = "nt" > Upstage< / span > ](< span class = "na" > https://github.com/upstage/ " Visit Upstage!" < / span > )
2022-12-02 15:05:54 +00:00
< / span > < / span > < / code > < / pre > < / div >
< div class = "box notices cstyle secondary" >
< div class = "box-label" > < i class = "fa-fw fas fa-eye" > < / i > Result< / div >
< div class = "box-content" >
2022-04-02 13:30:16 +00:00
< p > < a href = "https://github.com/upstage/" title = "Visit Upstage!" > Upstage< / a > < / p >
2022-12-02 15:05:54 +00:00
< / div >
< / div >
< h3 id = "link-references" > Link References< / h3 >
< p > Links can be simplyfied for recurring reuse by using a reference ID to later define the URL location. This simplyfies writing if you want to use a link more than once in a document.< / p >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < span class = "line" > < span class = "cl" > [Example][somelinkID]
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > [somelinkID]: https://example.com " Go to example domain"
< / span > < / span > < / code > < / pre > < / div >
< div class = "box notices cstyle secondary" >
< div class = "box-label" > < i class = "fa-fw fas fa-eye" > < / i > Result< / div >
< div class = "box-content" >
< p > < a href = "https://example.com" title = "Go to example domain" > Example< / a > < / p >
< / div >
< / div >
< h3 id = "footnotes" > Footnotes< / h3 >
< p > Footnotes work mostly like reference-style links. A footnote is made of two things, a marker in the text that will become a superscript number and a footnote definition that will be placed in a list of footnotes.< / p >
< p > Usually the list of footnotes will be shown at the end of your document. If we use a footnote in a notice box it will instead be listed at the end of its box.< / p >
< p > Footnotes can contain block elements, which means that you can put multiple paragraphs, lists, blockquotes and so on in a footnote. It works the same as for list items, just indent the following paragraphs by four spaces in the footnote definition.< / p >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < span class = "line" > < span class = "cl" > That' s some text with a footnote[^1]
2022-04-02 13:30:16 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" >
2022-12-02 15:05:54 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > [^1]: And that' s the footnote.
2022-04-02 13:30:16 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" >
2022-12-02 15:05:54 +00:00
< / span > < / span > < span class = "line" > < span class = "cl" > That' s some more text with a footnote.[^someid]
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > [^someid]:
< / span > < / span > < span class = "line" > < span class = "cl" > Anything of interest goes here.
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > Blue light glows blue.
2022-10-08 19:39:32 +00:00
< / span > < / span > < / code > < / pre > < / div >
2022-12-02 15:05:54 +00:00
< div class = "box notices cstyle secondary" >
< div class = "box-label" > < i class = "fa-fw fas fa-eye" > < / i > Result< / div >
2022-12-01 00:38:08 +00:00
< div class = "box-content" >
2022-12-02 15:05:54 +00:00
< p > That’ s some text with a footnote< sup id = "fnref:1" > < a href = "#fn:1" class = "footnote-ref" role = "doc-noteref" > 1< / a > < / sup > < / p >
< p > That’ s some more text with a footnote.< sup id = "fnref:2" > < a href = "#fn:2" class = "footnote-ref" role = "doc-noteref" > 2< / a > < / sup > < / p >
< div class = "footnotes" role = "doc-endnotes" >
< hr >
< ol >
< li id = "fn:1" >
< p > And that’ s the footnote.  < a href = "#fnref:1" class = "footnote-backref" role = "doc-backlink" > ↩ ︎ < / a > < / p >
< / li >
< li id = "fn:2" >
< p > Anything of interest goes here.< / p >
< p > Blue light glows blue.  < a href = "#fnref:2" class = "footnote-backref" role = "doc-backlink" > ↩ ︎ < / a > < / p >
< / li >
< / ol >
< / div >
2022-10-08 19:39:32 +00:00
< / div >
< / div >
2022-04-02 13:30:16 +00:00
< h2 id = "images" > Images< / h2 >
2022-12-02 15:05:54 +00:00
< h3 id = "basic-images" > Basic Images< / h3 >
< p > Images have a similar syntax to links but include a preceding exclamation mark.< / p >
2022-10-08 19:39:32 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < span class = "line" > < span class = "cl" > ![< span class = "nt" > Spock< / span > ](< span class = "na" > https://octodex.github.com/images/spocktocat.png< / span > )
2022-12-02 15:05:54 +00:00
< / span > < / span > < / code > < / pre > < / div >
< div class = "box notices cstyle secondary" >
< div class = "box-label" > < i class = "fa-fw fas fa-eye" > < / i > Result< / div >
< div class = "box-content" >
< p >
2022-11-06 15:27:13 +00:00
2022-12-02 15:05:54 +00:00
< a href = "https://octodex.github.com/images/spocktocat.png?width=20vw&classes=bg-white" data-featherlight = "image" >
< img src = "https://octodex.github.com/images/spocktocat.png?width=20vw&classes=bg-white" alt = "Spock" class = "bg-white" style = "height: auto; width: 20vw;" loading = "lazy" >
2022-11-06 15:27:13 +00:00
< / a > < / p >
2022-12-02 15:05:54 +00:00
< / div >
< / div >
< h3 id = "image-with-tooltip" > Image with Tooltip< / h3 >
< p > Like links, images can also be given a tooltip.< / p >
2022-10-08 19:39:32 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < span class = "line" > < span class = "cl" > ![< span class = "nt" > Picard< / span > ](< span class = "na" > https://octodex.github.com/images/jean-luc-picat.jpg " Jean Luc Picard" < / span > )
2022-12-02 15:05:54 +00:00
< / span > < / span > < / code > < / pre > < / div >
< div class = "box notices cstyle secondary" >
< div class = "box-label" > < i class = "fa-fw fas fa-eye" > < / i > Result< / div >
< div class = "box-content" >
< p >
2022-11-06 15:27:13 +00:00
2022-11-18 23:25:43 +00:00
< a href = "https://octodex.github.com/images/jean-luc-picat.jpg?width=20vw" data-featherlight = "image" >
< img src = "https://octodex.github.com/images/jean-luc-picat.jpg?width=20vw" alt = "Picard" title = "Jean Luc Picard" style = "height: auto; width: 20vw;" loading = "lazy" >
2022-11-06 15:27:13 +00:00
< / a > < / p >
2022-12-02 15:05:54 +00:00
< / div >
< / div >
< h3 id = "image-references" > Image References< / h3 >
< p > Images can also be linked by reference ID to later define the URL location. This simplyfies writing if you want to use an image more than once in a document.< / p >
2022-10-08 19:39:32 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < span class = "line" > < span class = "cl" > ![La Forge][laforge]
< / span > < / span > < span class = "line" > < span class = "cl" >
< / span > < / span > < span class = "line" > < span class = "cl" > [laforge]: https://octodex.github.com/images/trekkie.jpg " Geordi La Forge"
2022-12-02 15:05:54 +00:00
< / span > < / span > < / code > < / pre > < / div >
< div class = "box notices cstyle secondary" >
< div class = "box-label" > < i class = "fa-fw fas fa-eye" > < / i > Result< / div >
< div class = "box-content" >
< p >
2022-11-06 15:27:13 +00:00
2022-11-18 23:25:43 +00:00
< a href = "https://octodex.github.com/images/trekkie.jpg?width=20vw" data-featherlight = "image" >
< img src = "https://octodex.github.com/images/trekkie.jpg?width=20vw" alt = "La Forge" title = "Geordi La Forge" style = "height: auto; width: 20vw;" loading = "lazy" >
2022-11-06 15:27:13 +00:00
< / a > < / p >
2022-12-02 15:05:54 +00:00
< / div >
< / div >
< h3 id = "further-image-formatting" > Further Image Formatting< / h3 >
< p > This theme allows additional non-standard formatting by setting query parameter at the end of the image URL.< / p >
< h4 id = "resizing" > Resizing< / h4 >
< p > Add query parameter < 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 >
2022-10-08 19:39:32 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < span class = "line" > < span class = "cl" > ![< span class = "nt" > Minion< / span > ](< span class = "na" > https://octodex.github.com/images/minion.png?width=20vw< / span > )
2022-12-02 15:05:54 +00:00
< / span > < / span > < / code > < / pre > < / div >
< div class = "box notices cstyle secondary" >
< div class = "box-label" > < i class = "fa-fw fas fa-eye" > < / i > Result< / div >
< div class = "box-content" >
< p >
2022-11-06 15:27:13 +00:00
2022-12-02 15:05:54 +00:00
< a href = "https://octodex.github.com/images/minion.png?width=20vw&classes=bg-white" data-featherlight = "image" >
< img src = "https://octodex.github.com/images/minion.png?width=20vw&classes=bg-white" alt = "Minion" class = "bg-white" style = "height: auto; width: 20vw;" loading = "lazy" >
2022-11-06 15:27:13 +00:00
< / a > < / p >
2022-12-02 15:05:54 +00:00
< / div >
< / div >
2022-04-02 13:30:16 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < span class = "line" > < span class = "cl" > ![< span class = "nt" > Minion< / span > ](< span class = "na" > https://octodex.github.com/images/minion.png?height=50px< / span > )
2022-12-02 15:05:54 +00:00
< / span > < / span > < / code > < / pre > < / div >
< div class = "box notices cstyle secondary" >
< div class = "box-label" > < i class = "fa-fw fas fa-eye" > < / i > Result< / div >
< div class = "box-content" >
< p >
2022-11-06 15:27:13 +00:00
2022-12-02 15:05:54 +00:00
< a href = "https://octodex.github.com/images/minion.png?height=50px&classes=bg-white" data-featherlight = "image" >
< img src = "https://octodex.github.com/images/minion.png?height=50px&classes=bg-white" alt = "Minion" class = "bg-white" style = "height: 50px; width: auto;" loading = "lazy" >
2022-11-06 15:27:13 +00:00
< / a > < / p >
2022-12-02 15:05:54 +00:00
< / div >
< / div >
2022-10-08 19:39:32 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < span class = "line" > < span class = "cl" > ![< span class = "nt" > Minion< / span > ](< span class = "na" > https://octodex.github.com/images/minion.png?height=50px& width=40vw< / span > )
2022-12-02 15:05:54 +00:00
< / span > < / span > < / code > < / pre > < / div >
< div class = "box notices cstyle secondary" >
< div class = "box-label" > < i class = "fa-fw fas fa-eye" > < / i > Result< / div >
< div class = "box-content" >
< p >
2022-11-06 15:27:13 +00:00
2022-12-02 15:05:54 +00:00
< a href = "https://octodex.github.com/images/minion.png?height=50px&width=40vw&classes=bg-white" data-featherlight = "image" >
< img src = "https://octodex.github.com/images/minion.png?height=50px&width=40vw&classes=bg-white" alt = "Minion" class = "bg-white" style = "height: 50px; width: 40vw;" loading = "lazy" >
2022-11-06 15:27:13 +00:00
< / a > < / p >
2022-12-02 15:05:54 +00:00
< / div >
< / div >
< h4 id = "css-classes" > CSS Classes< / h4 >
< p > Add a query parameter < code > classes< / code > to the link image to add CSS classes. Add some of the predefined values or even define your own in your CSS.< / p >
< h5 id = "shadow" > Shadow< / h5 >
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < span class = "line" > < span class = "cl" > ![< span class = "nt" > Spidertocat< / span > ](< span class = "na" > https://octodex.github.com/images/spidertocat.png?classes=shadow,bg-white< / span > )
< / span > < / span > < / code > < / pre > < / div >
< div class = "box notices cstyle secondary" >
< div class = "box-label" > < i class = "fa-fw fas fa-eye" > < / i > Result< / div >
< div class = "box-content" >
< p >
2022-11-06 15:27:13 +00:00
2022-12-02 15:05:54 +00:00
< a href = "https://octodex.github.com/images/spidertocat.png?width=20vw&classes=shadow,bg-white" data-featherlight = "image" >
< img src = "https://octodex.github.com/images/spidertocat.png?width=20vw&classes=shadow,bg-white" alt = "Spidertocat" class = "shadow bg-white" style = "height: auto; width: 20vw;" loading = "lazy" >
2022-11-06 15:27:13 +00:00
< / a > < / p >
2022-12-02 15:05:54 +00:00
< / div >
< / div >
< h5 id = "border" > Border< / h5 >
2022-10-08 19:39:32 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < span class = "line" > < span class = "cl" > ![< span class = "nt" > DrOctocat< / span > ](< span class = "na" > https://octodex.github.com/images/droctocat.png?classes=border< / span > )
2022-12-02 15:05:54 +00:00
< / span > < / span > < / code > < / pre > < / div >
< div class = "box notices cstyle secondary" >
< div class = "box-label" > < i class = "fa-fw fas fa-eye" > < / i > Result< / div >
< div class = "box-content" >
< p >
2022-11-06 15:27:13 +00:00
2022-11-18 23:25:43 +00:00
< a href = "https://octodex.github.com/images/droctocat.png?width=20vw&classes=border" data-featherlight = "image" >
< img src = "https://octodex.github.com/images/droctocat.png?width=20vw&classes=border" alt = "DrOctocat" class = "border" style = "height: auto; width: 20vw;" loading = "lazy" >
2022-11-06 15:27:13 +00:00
< / a > < / p >
2022-12-02 15:05:54 +00:00
< / div >
< / div >
< h5 id = "left" > Left< / h5 >
2022-10-08 19:39:32 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < span class = "line" > < span class = "cl" > ![< span class = "nt" > Supertocat< / span > ](< span class = "na" > https://octodex.github.com/images/okal-eltocat.jpg?classes=left< / span > )
2022-12-02 15:05:54 +00:00
< / span > < / span > < / code > < / pre > < / div >
< div class = "box notices cstyle secondary" >
< div class = "box-label" > < i class = "fa-fw fas fa-eye" > < / i > Result< / div >
< div class = "box-content" >
< p >
2022-11-06 15:27:13 +00:00
2022-11-18 23:25:43 +00:00
< a href = "https://octodex.github.com/images/okal-eltocat.jpg?width=20vw&classes=left" data-featherlight = "image" >
< img src = "https://octodex.github.com/images/okal-eltocat.jpg?width=20vw&classes=left" alt = "Supertocat" class = "left" style = "height: auto; width: 20vw;" loading = "lazy" >
2022-11-06 15:27:13 +00:00
< / a > < / p >
2022-12-02 15:05:54 +00:00
< / div >
< / div >
< h5 id = "right" > Right< / h5 >
2022-10-08 19:39:32 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < span class = "line" > < span class = "cl" > ![< span class = "nt" > Riddlocat< / span > ](< span class = "na" > https://octodex.github.com/images/riddlocat.jpg?classes=right< / span > )
2022-12-02 15:05:54 +00:00
< / span > < / span > < / code > < / pre > < / div >
< div class = "box notices cstyle secondary" >
< div class = "box-label" > < i class = "fa-fw fas fa-eye" > < / i > Result< / div >
< div class = "box-content" >
< p >
2022-11-06 15:27:13 +00:00
2022-11-18 23:25:43 +00:00
< a href = "https://octodex.github.com/images/riddlocat.jpg?width=20vw&classes=right" data-featherlight = "image" >
< img src = "https://octodex.github.com/images/riddlocat.jpg?width=20vw&classes=right" alt = "Riddlocat" class = "right" style = "height: auto; width: 20vw;" loading = "lazy" >
2022-11-06 15:27:13 +00:00
< / a > < / p >
2022-12-02 15:05:54 +00:00
< / div >
< / div >
< h5 id = "inline" > Inline< / h5 >
2022-10-08 19:39:32 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < span class = "line" > < span class = "cl" > ![< span class = "nt" > Spidertocat< / span > ](< span class = "na" > https://octodex.github.com/images/spidertocat.png?classes=inline< / span > )
< / span > < / span > < span class = "line" > < span class = "cl" > ![< span class = "nt" > DrOctocat< / span > ](< span class = "na" > https://octodex.github.com/images/droctocat.png?classes=inline< / span > )
< / span > < / span > < span class = "line" > < span class = "cl" > ![< span class = "nt" > Supertocat< / span > ](< span class = "na" > https://octodex.github.com/images/okal-eltocat.jpg?classes=inline< / span > )
< / span > < / span > < span class = "line" > < span class = "cl" > ![< span class = "nt" > Riddlocat< / span > ](< span class = "na" > https://octodex.github.com/images/riddlocat.jpg?classes=inline< / span > )
2022-12-02 15:05:54 +00:00
< / span > < / span > < / code > < / pre > < / div >
< div class = "box notices cstyle secondary" >
< div class = "box-label" > < i class = "fa-fw fas fa-eye" > < / i > Result< / div >
< div class = "box-content" >
< p >
2022-11-06 15:27:13 +00:00
2022-12-02 15:05:54 +00:00
< a href = "https://octodex.github.com/images/spidertocat.png?width=10vw&classes=inline,bg-white" data-featherlight = "image" >
< img src = "https://octodex.github.com/images/spidertocat.png?width=10vw&classes=inline,bg-white" alt = "Spidertocat" class = "inline bg-white" style = "height: auto; width: 10vw;" loading = "lazy" >
2022-11-06 15:27:13 +00:00
< / a >
2022-11-05 23:35:48 +00:00
2022-11-06 15:27:13 +00:00
2022-11-18 23:25:43 +00:00
< a href = "https://octodex.github.com/images/droctocat.png?width=10vw&classes=inline" data-featherlight = "image" >
< img src = "https://octodex.github.com/images/droctocat.png?width=10vw&classes=inline" alt = "DrOctocat" class = "inline" style = "height: auto; width: 10vw;" loading = "lazy" >
2022-11-06 15:27:13 +00:00
< / a >
2022-11-05 23:35:48 +00:00
2022-11-06 15:27:13 +00:00
2022-11-18 23:25:43 +00:00
< a href = "https://octodex.github.com/images/okal-eltocat.jpg?width=10vw&classes=inline" data-featherlight = "image" >
< img src = "https://octodex.github.com/images/okal-eltocat.jpg?width=10vw&classes=inline" alt = "Supertocat" class = "inline" style = "height: auto; width: 10vw;" loading = "lazy" >
2022-11-06 15:27:13 +00:00
< / a >
2022-11-05 23:35:48 +00:00
2022-11-06 15:27:13 +00:00
2022-11-18 23:25:43 +00:00
< a href = "https://octodex.github.com/images/riddlocat.jpg?width=10vw&classes=inline" data-featherlight = "image" >
< img src = "https://octodex.github.com/images/riddlocat.jpg?width=10vw&classes=inline" alt = "Riddlocat" class = "inline" style = "height: auto; width: 10vw;" loading = "lazy" >
2022-11-06 15:27:13 +00:00
< / a > < / p >
2022-12-02 15:05:54 +00:00
< / div >
< / div >
2022-11-06 15:27:13 +00:00
< h5 id = "combination" > Combination< / h5 >
2022-12-02 15:05:54 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < span class = "line" > < span class = "cl" > ![< span class = "nt" > X-tocat< / span > ](< span class = "na" > https://octodex.github.com/images/xtocat.jpg?classes=shadow,border,left< / span > )
< / span > < / span > < / code > < / pre > < / div >
< div class = "box notices cstyle secondary" >
< div class = "box-label" > < i class = "fa-fw fas fa-eye" > < / i > Result< / div >
< div class = "box-content" >
< p >
2022-11-06 15:27:13 +00:00
2022-11-18 23:25:43 +00:00
< a href = "https://octodex.github.com/images/xtocat.jpg?width=20vw&classes=shadow,border,left" data-featherlight = "image" >
< img src = "https://octodex.github.com/images/xtocat.jpg?width=20vw&classes=shadow,border,left" alt = "X-tocat" class = "shadow border left" style = "height: auto; width: 20vw;" loading = "lazy" >
2022-11-06 15:27:13 +00:00
< / a > < / p >
2022-12-02 15:05:54 +00:00
< / div >
< / div >
2022-04-02 13:30:16 +00:00
< h4 id = "lightbox" > Lightbox< / h4 >
2022-12-02 15:05:54 +00:00
< p > Add the query parameter < code > featherlight=false< / code > to the image link to disable the lightbox.< / p >
2022-10-08 19:39:32 +00:00
< div class = "highlight" > < pre tabindex = "0" class = "chroma" > < code class = "language-markdown" data-lang = "markdown" > < span class = "line" > < span class = "cl" > ![< span class = "nt" > Homercat< / span > ](< span class = "na" > https://octodex.github.com/images/homercat.png?featherlight=false< / span > )
2022-12-02 15:05:54 +00:00
< / span > < / span > < / code > < / pre > < / div >
< div class = "box notices cstyle secondary" >
< div class = "box-label" > < i class = "fa-fw fas fa-eye" > < / i > Result< / div >
< div class = "box-content" >
< p >
2022-11-06 15:27:13 +00:00
2022-12-02 15:05:54 +00:00
< img src = "https://octodex.github.com/images/homercat.png?width=20vw&featherlight=false&classes=bg-white" alt = "Homercat" class = "bg-white" style = "height: auto; width: 20vw;" loading = "lazy" > < / p >
< / div >
< / div >
2022-04-02 13:30:16 +00:00
< footer class = "footline" >
< / footer >
< / article >
< / div >
< / main >
< / div >
2022-12-02 15:21:29 +00:00
< script src = "../../js/clipboard.min.js?1669994484" defer > < / script >
< script src = "../../js/perfect-scrollbar.min.js?1669994484" defer > < / script >
< script src = "../../js/featherlight.min.js?1669994484" defer > < / script >
< script src = "../../js/theme.js?1669994484" defer > < / script >
2022-04-02 13:30:16 +00:00
< / body >
< / html >
