RubyGems - jekyll-docs - Versions diffs - 3.9.0 → 4.0.0 - Mend

jekyll-docs 3.9.0 → 4.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (225) hide show

checksums.yaml +4 -4
data/lib/jekyll-docs.rb +3 -3
data/site/404.html +10 -7
data/site/css/screen.css +3 -1
data/site/css/screen.css.map +28 -0
data/site/docs/assets/index.html +412 -453
data/site/docs/code_of_conduct/index.html +447 -501
data/site/docs/collections/index.html +487 -674
data/site/docs/community/bug/index.html +603 -0
data/site/docs/community/index.html +635 -0
data/site/docs/conduct/index.html +447 -515
data/site/docs/configuration/default/index.html +682 -0
data/site/docs/configuration/environments/index.html +641 -0
data/site/docs/configuration/front-matter-defaults/index.html +738 -0
data/site/docs/configuration/incremental-regeneration/index.html +631 -0
data/site/docs/configuration/index.html +405 -1230
data/site/docs/configuration/liquid/index.html +616 -0
data/site/docs/configuration/markdown/index.html +766 -0
data/site/docs/configuration/options/index.html +1011 -0
data/site/docs/configuration/webrick/index.html +615 -0
data/site/docs/continuous-integration/buddyworks/index.html +393 -479
data/site/docs/continuous-integration/circleci/index.html +465 -481
data/site/docs/continuous-integration/travis-ci/index.html +450 -507
data/site/docs/contributing/index.html +425 -514
data/site/docs/datafiles/index.html +411 -453
data/site/docs/deployment-methods/index.html +9 -871
data/site/docs/deployment/automated/index.html +663 -0
data/site/docs/deployment/index.html +607 -0
data/site/docs/deployment/manual/index.html +631 -0
data/site/docs/deployment/third-party/index.html +639 -0
data/site/docs/drafts/index.html +9 -634
data/site/docs/extras/index.html +9 -687
data/site/docs/front-matter/index.html +799 -0
data/site/docs/frontmatter/index.html +9 -819
data/site/docs/github-pages/index.html +407 -475
data/site/docs/history/index.html +1370 -1154
data/site/docs/home/index.html +9 -627
data/site/docs/includes/index.html +425 -501
data/site/docs/index.html +630 -9
data/site/docs/installation/index.html +403 -540
data/site/docs/installation/macos/index.html +716 -0
data/site/docs/installation/other-linux/index.html +613 -0
data/site/docs/installation/ubuntu/index.html +623 -0
data/site/docs/installation/windows/index.html +733 -0
data/site/docs/layouts/index.html +726 -0
data/site/docs/liquid/filters/index.html +1169 -0
data/site/docs/liquid/index.html +615 -0
data/site/docs/liquid/tags/index.html +728 -0
data/site/docs/maintaining/affinity-team-captain/index.html +395 -479
data/site/docs/maintaining/avoiding-burnout/index.html +391 -475
data/site/docs/maintaining/becoming-a-maintainer/index.html +391 -475
data/site/docs/maintaining/index.html +391 -486
data/site/docs/maintaining/merging-a-pull-request/index.html +406 -490
data/site/docs/maintaining/releasing-a-new-version/index.html +409 -485
data/site/docs/maintaining/reviewing-a-pull-request/index.html +392 -476
data/site/docs/maintaining/special-labels/index.html +397 -481
data/site/docs/maintaining/triaging-an-issue/index.html +394 -478
data/site/docs/markdown-101/index.html +601 -0
data/site/docs/migrations/index.html +396 -440
data/site/docs/pages/index.html +408 -482
data/site/docs/pagination/index.html +450 -509
data/site/docs/permalinks/index.html +552 -587
data/site/docs/plugins/commands/index.html +656 -0
data/site/docs/plugins/converters/index.html +685 -0
data/site/docs/plugins/filters/index.html +624 -0
data/site/docs/plugins/generators/index.html +697 -0
data/site/docs/plugins/hooks/index.html +838 -0
data/site/docs/plugins/index.html +415 -1565
data/site/docs/plugins/installation/index.html +681 -0
data/site/docs/plugins/tags/index.html +699 -0
data/site/docs/plugins/your-first-plugin/index.html +741 -0
data/site/docs/posts/index.html +491 -627
data/site/docs/quickstart/index.html +9 -645
data/site/docs/resources/index.html +9 -761
data/site/docs/ruby-101/index.html +640 -0
data/site/docs/sites/index.html +9 -696
data/site/docs/static-files/index.html +401 -433
data/site/docs/step-by-step/01-setup/index.html +771 -0
data/site/docs/step-by-step/02-liquid/index.html +756 -0
data/site/docs/step-by-step/03-front-matter/index.html +730 -0
data/site/docs/step-by-step/04-layouts/index.html +770 -0
data/site/docs/step-by-step/05-includes/index.html +768 -0
data/site/docs/step-by-step/06-data-files/index.html +738 -0
data/site/docs/step-by-step/07-assets/index.html +773 -0
data/site/docs/step-by-step/08-blogging/index.html +835 -0
data/site/docs/step-by-step/09-collections/index.html +932 -0
data/site/docs/step-by-step/10-deployment/index.html +842 -0
data/site/docs/structure/index.html +411 -430
data/site/docs/support/index.html +392 -476
data/site/docs/templates/index.html +9 -1232
data/site/docs/themes/index.html +487 -521
data/site/docs/troubleshooting/index.html +443 -520
data/site/docs/upgrading/0-to-2/index.html +437 -523
data/site/docs/upgrading/2-to-3/index.html +422 -507
data/site/docs/upgrading/3-to-4/index.html +765 -0
data/site/docs/upgrading/index.html +395 -478
data/site/docs/usage/index.html +409 -506
data/site/docs/variables/index.html +504 -652
data/site/docs/windows/index.html +9 -784
data/site/feed.xml +269 -188
data/site/feed/release.xml +324 -0
data/site/fonts/lato-v14-latin-300.woff +0 -0
data/site/fonts/lato-v14-latin-300.woff2 +0 -0
data/site/fonts/lato-v14-latin-300italic.woff +0 -0
data/site/fonts/lato-v14-latin-300italic.woff2 +0 -0
data/site/fonts/lato-v14-latin-700.woff +0 -0
data/site/fonts/lato-v14-latin-700.woff2 +0 -0
data/site/fonts/lato-v14-latin-700italic.woff +0 -0
data/site/fonts/lato-v14-latin-700italic.woff2 +0 -0
data/site/fonts/lato-v14-latin-900.woff +0 -0
data/site/fonts/lato-v14-latin-900.woff2 +0 -0
data/site/fonts/lato-v14-latin-900italic.woff +0 -0
data/site/fonts/lato-v14-latin-900italic.woff2 +0 -0
data/site/fonts/lato-v14-latin-italic.woff +0 -0
data/site/fonts/lato-v14-latin-italic.woff2 +0 -0
data/site/fonts/lato-v14-latin-regular.woff +0 -0
data/site/fonts/lato-v14-latin-regular.woff2 +0 -0
data/site/help/index.html +9 -247
data/site/img/forestry-logo.svg +19 -0
data/site/img/jekyll-og.png +0 -0
data/site/img/spacer.gif +0 -0
data/site/index.html +56 -29
data/site/jekyllconf/index.html +62 -35
data/site/latest_version.txt +1 -1
data/site/news/2013/05/05/jekyll-1-0-0-released/index.html +180 -115
data/site/news/2013/05/08/jekyll-1-0-1-released/index.html +182 -117
data/site/news/2013/05/12/jekyll-1-0-2-released/index.html +183 -118
data/site/news/2013/06/07/jekyll-1-0-3-released/index.html +184 -119
data/site/news/2013/07/14/jekyll-1-1-0-released/index.html +183 -118
data/site/news/2013/07/24/jekyll-1-1-1-released/index.html +180 -115
data/site/news/2013/07/25/jekyll-1-0-4-released/index.html +182 -117
data/site/news/2013/07/25/jekyll-1-1-2-released/index.html +182 -117
data/site/news/2013/09/06/jekyll-1-2-0-released/index.html +185 -120
data/site/news/2013/09/14/jekyll-1-2-1-released/index.html +183 -118
data/site/news/2013/10/28/jekyll-1-3-0-rc1-released/index.html +180 -115
data/site/news/2013/11/04/jekyll-1-3-0-released/index.html +189 -124
data/site/news/2013/11/26/jekyll-1-3-1-released/index.html +181 -116
data/site/news/2013/12/07/jekyll-1-4-0-released/index.html +181 -116
data/site/news/2013/12/09/jekyll-1-4-1-released/index.html +180 -115
data/site/news/2013/12/16/jekyll-1-4-2-released/index.html +182 -117
data/site/news/2014/01/13/jekyll-1-4-3-released/index.html +181 -116
data/site/news/2014/03/24/jekyll-1-5-0-released/index.html +181 -116
data/site/news/2014/03/27/jekyll-1-5-1-released/index.html +181 -116
data/site/news/2014/05/06/jekyll-turns-2-0-0/index.html +184 -119
data/site/news/2014/05/08/jekyll-2-0-3-released/index.html +180 -115
data/site/news/2014/06/04/jekyll-stickers-1-dollar-stickermule/index.html +181 -116
data/site/news/2014/06/28/jekyll-turns-21-i-mean-2-1-0/index.html +185 -120
data/site/news/2014/07/01/jekyll-2-1-1-released/index.html +182 -117
data/site/news/2014/07/29/jekyll-2-2-0-released/index.html +181 -116
data/site/news/2014/08/10/jekyll-2-3-0-released/index.html +189 -124
data/site/news/2014/09/09/jekyll-2-4-0-released/index.html +187 -122
data/site/news/2014/11/05/jekylls-midlife-crisis-jekyll-turns-2-5-0/index.html +188 -123
data/site/news/2014/11/09/jekyll-2-5-1-released/index.html +180 -115
data/site/news/2014/11/12/jekyll-2-5-2-released/index.html +182 -117
data/site/news/2014/12/17/alfredxing-welcome-to-jekyll-core/index.html +179 -114
data/site/news/2014/12/22/jekyll-2-5-3-released/index.html +180 -115
data/site/news/2015/01/20/jekyll-meet-and-greet/index.html +179 -114
data/site/news/2015/01/24/jekyll-3-0-0-beta1-released/index.html +180 -115
data/site/news/2015/02/26/introducing-jekyll-talk/index.html +180 -115
data/site/news/2015/10/26/jekyll-3-0-released/index.html +185 -120
data/site/news/2015/11/17/jekyll-3-0-1-released/index.html +184 -119
data/site/news/2016/01/20/jekyll-3-0-2-released/index.html +182 -117
data/site/news/2016/01/24/jekyll-3-1-0-released/index.html +186 -121
data/site/news/2016/01/28/jekyll-3-1-1-released/index.html +183 -118
data/site/news/2016/02/08/jekyll-3-0-3-released/index.html +181 -116
data/site/news/2016/02/19/jekyll-3-1-2-released/index.html +182 -117
data/site/news/2016/03/10/making-it-easier-to-contribute-to-jekyll/index.html +179 -114
data/site/news/2016/04/19/jekyll-3-0-4-released/index.html +181 -116
data/site/news/2016/04/19/jekyll-3-1-3-released/index.html +181 -116
data/site/news/2016/04/26/jekyll-3-0-5-released/index.html +180 -115
data/site/news/2016/05/18/jekyll-3-1-4-released/index.html +186 -121
data/site/news/2016/05/18/jekyll-3-1-5-released/index.html +181 -116
data/site/news/2016/05/19/jekyll-3-1-6-released/index.html +181 -116
data/site/news/2016/06/03/update-on-jekyll-s-google-summer-of-code-projects/index.html +179 -114
data/site/news/2016/07/26/jekyll-3-2-0-released/index.html +184 -119
data/site/news/2016/08/02/jekyll-3-2-1-released/index.html +180 -115
data/site/news/2016/08/24/jekyll-admin-initial-release/index.html +179 -114
data/site/news/2016/10/06/jekyll-3-3-is-here/index.html +207 -142
data/site/news/2016/11/14/jekyll-3-3-1-released/index.html +181 -116
data/site/news/2017/01/18/jekyll-3-4-0-released/index.html +183 -118
data/site/news/2017/03/02/jekyll-3-4-1-released/index.html +181 -116
data/site/news/2017/03/09/jekyll-3-4-2-released/index.html +189 -124
data/site/news/2017/03/21/jekyll-3-4-3-released/index.html +190 -125
data/site/news/2017/06/15/jekyll-3-5-0-released/index.html +187 -122
data/site/news/2017/07/17/jekyll-3-5-1-released/index.html +182 -117
data/site/news/2017/08/12/jekyll-3-5-2-released/index.html +185 -120
data/site/news/2017/09/21/jekyll-3-6-0-released/index.html +181 -116
data/site/news/2017/10/19/diversity-open-source/index.html +181 -116
data/site/news/2017/10/21/jekyll-3-6-2-released/index.html +183 -118
data/site/news/2018/01/02/jekyll-3-7-0-released/index.html +184 -119
data/site/news/2018/01/25/jekyll-3-7-2-released/index.html +189 -124
data/site/news/2018/02/19/meet-jekyll-s-new-lead-developer/index.html +180 -115
data/site/news/2018/02/24/jekyll-3-7-3-released/index.html +185 -120
data/site/news/2018/04/19/development-update/index.html +699 -0
data/site/news/2018/04/19/jekyll-3-8-0-released/index.html +715 -0
data/site/news/2018/05/01/jekyll-3-8-1-released/index.html +182 -117
data/site/news/2018/05/19/jekyll-3-8-2-released/index.html +181 -116
data/site/news/2018/06/05/jekyll-3-8-3-released/index.html +183 -118
data/site/news/2018/08/01/jekyll-sponsoring/index.html +748 -0
data/site/news/2018/09/19/security-fixes-for-3-6-3-7-3-8/index.html +692 -0
data/site/news/2018/11/04/jekyll-3-8-5-released/index.html +682 -0
data/site/news/2019/03/18/jekyll-4-0-0-pre-alpha1-released/index.html +710 -0
data/site/news/2019/07/02/jekyll-3-8-6-released/index.html +180 -115
data/site/news/2019/07/20/jekyll-4-0-0-pre-beta1-released/index.html +11 -0
data/site/news/2019/08/04/jekyll-4-0-0-pre-beta1-released/index.html +708 -0
data/site/news/2019/08/20/jekyll-4-0-0-released/index.html +809 -0
data/site/news/index.html +976 -326
data/site/news/releases/index.html +820 -321
data/site/{philosophy.html → philosophy/index.html} +1 -1
data/site/redirects.json +1 -1
data/site/resources/index.html +332 -0
data/site/showcase/index.html +844 -0
data/site/sitemap.xml +256 -81
data/site/team/index.html +63 -77
data/site/tutorials/cache-api/index.html +418 -0
data/site/tutorials/convert-site-to-jekyll/index.html +155 -124
data/site/tutorials/custom-404-page/index.html +76 -43
data/site/tutorials/home/index.html +64 -37
data/site/tutorials/navigation/index.html +186 -103
data/site/tutorials/orderofinterpretation/index.html +80 -53
data/site/tutorials/using-jekyll-with-bundler/index.html +80 -51
data/site/tutorials/video-walkthroughs/index.html +62 -35
metadata +102 -13
data/site/community/index.html +0 -11
data/site/docs/continuous-integration/index.html +0 -681

data/site/docs/plugins/your-first-plugin/index.html ADDED

@@ -0,0 +1,741 @@
+<!DOCTYPE HTML>
+<html lang="en-US">
+<head>
+  <meta charset="UTF-8">
+  <meta name="viewport" content="width=device-width,initial-scale=1">
+  <meta name="generator" content="Jekyll v4.0.0">
+  <link type="application/atom+xml" rel="alternate" href="https://jekyllrb.com/feed.xml" title="Jekyll • Simple, blog-aware, static sites" />
+  <link type="application/atom+xml" rel="alternate" href="/feed/release.xml" title="Jekyll releases posts" />
+  <link rel="alternate" type="application/atom+xml" title="Recent commits to Jekyll’s master branch" href="https://github.com/jekyll/jekyll/commits/master.atom">
+  <link rel="preload" href="/fonts/lato-v14-latin-300.woff2" as="font" type="font/woff2" crossorigin />
+  <link rel="preload" href="/fonts/lato-v14-latin-700.woff2" as="font" type="font/woff2" crossorigin />
+  <link rel="preload" href="/css/screen.css" as="style">
+  <link rel="stylesheet" href="/css/screen.css">
+  <link rel="icon" type="image/x-icon" href="/favicon.ico">
+  <!-- Begin Jekyll SEO tag v2.6.1 -->
+<title>Your first plugin | Jekyll • Simple, blog-aware, static sites</title>
+<meta name="generator" content="Jekyll v4.0.0" />
+<meta property="og:title" content="Your first plugin" />
+<meta property="og:locale" content="en_US" />
+<meta name="description" content="Plugins allow you to extend Jekyll’s behavior to fit your needs. There are six types of plugins in Jekyll." />
+<meta property="og:description" content="Plugins allow you to extend Jekyll’s behavior to fit your needs. There are six types of plugins in Jekyll." />
+<link rel="canonical" href="https://jekyllrb.com/docs/plugins/your-first-plugin/" />
+<meta property="og:url" content="https://jekyllrb.com/docs/plugins/your-first-plugin/" />
+<meta property="og:site_name" content="Jekyll • Simple, blog-aware, static sites" />
+<meta property="og:image" content="https://jekyllrb.com/img/jekyll-og.png" />
+<meta property="og:type" content="article" />
+<meta property="article:published_time" content="2019-09-11T07:30:27-07:00" />
+<meta name="twitter:card" content="summary_large_image" />
+<meta property="twitter:image" content="https://jekyllrb.com/img/jekyll-og.png" />
+<meta property="twitter:title" content="Your first plugin" />
+<meta name="twitter:site" content="@jekyllrb" />
+<meta name="google-site-verification" content="onQcXpAvtHBrUI5LlroHNE_FP0b2qvFyPq7VZw36iEY" />
+<script type="application/ld+json">
+{"description":"Plugins allow you to extend Jekyll’s behavior to fit your needs. There are six types of plugins in Jekyll.","@type":"BlogPosting","mainEntityOfPage":{"@type":"WebPage","@id":"https://jekyllrb.com/docs/plugins/your-first-plugin/"},"headline":"Your first plugin","dateModified":"2019-09-11T07:30:27-07:00","url":"https://jekyllrb.com/docs/plugins/your-first-plugin/","datePublished":"2019-09-11T07:30:27-07:00","image":"https://jekyllrb.com/img/jekyll-og.png","publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"https://jekyllrb.com/img/logo-2x.png"}},"@context":"https://schema.org"}</script>
+<!-- End Jekyll SEO tag -->
+  <!--[if lt IE 9]>
+  <script src="/js/html5shiv.min.js"></script>
+  <script src="/js/respond.min.js"></script>
+  <![endif]-->
+</head>
+<body class="wrap">
+  <header>
+  <div class="flexbox">
+    <div class="center-on-mobiles">
+      <h1>
+        <a href="/" class="logo">
+          <span class="sr-only">Jekyll</span>
+          <img src="/img/logo-2x.png" width="140" height="65" alt="Jekyll Logo">
+        </a>
+      </h1>
+    </div>
+    <nav class="main-nav hide-on-mobiles">
+      <ul>
+  <li>
+    <a href="/">Home</a>
+  </li>
+  <li class="current">
+    <a href="/docs/">Docs</a>
+  </li>
+  <li>
+    <a href="/resources/">Resources</a>
+  </li>
+  <li>
+    <a href="/showcase/">Showcase</a>
+  </li>
+  <li>
+    <a href="/news/">News</a>
+  </li>
+</ul>
+    </nav>
+    <div class="search hide-on-mobiles">
+      <input type="text" id="docsearch-input" placeholder="Search the docs…">
+    </div>
+    <div class="meta hide-on-mobiles">
+      <ul>
+        <li>
+          <a href="https://github.com/jekyll/jekyll/releases/tag/v4.0.0">v4.0.0</a>
+        </li>
+        <li>
+          <a href="https://github.com/jekyll/jekyll">GitHub</a>
+        </li>
+      </ul>
+    </div>
+  </div>
+  <nav class="mobile-nav show-on-mobiles">
+    <ul>
+    <li>
+      <a href="/">Home</a>
+    </li>
+    <li class="current">
+      <a href="/docs/">Docs</a>
+    </li>
+    <li>
+      <a href="/resources/">Resources</a>
+    </li>
+    <li>
+      <a href="/news/">News</a>
+    </li>
+  <li>
+    <a href="https://github.com/jekyll/jekyll">GitHub</a>
+  </li>
+</ul>
+  </nav>
+</header>
+    <section class="docs">
+    <div class="grid">
+      <div class="docs-nav-mobile unit whole show-on-mobiles">
+  <select onchange="if (this.value) window.location.href=this.value">
+    <option value="">Navigate the docs…</option>
+    <optgroup label="Getting Started">
+        <option value="/docs/">
+          Quickstart
+        </option>
+        <option value="/docs/ruby-101/">
+          Ruby 101
+        </option>
+        <option value="/docs/installation/">
+          Installation
+        </option>
+        <option value="/docs/community/">
+          Community
+        </option>
+        <option value="/docs/step-by-step/01-setup/">
+          Step by Step Tutorial
+        </option>
+    </optgroup>
+    <optgroup label="Build">
+        <option value="/docs/usage/">
+          Command Line Usage
+        </option>
+        <option value="/docs/configuration/">
+          Configuration
+        </option>
+    </optgroup>
+    <optgroup label="Content">
+        <option value="/docs/pages/">
+          Pages
+        </option>
+        <option value="/docs/posts/">
+          Posts
+        </option>
+        <option value="/docs/front-matter/">
+          Front Matter
+        </option>
+        <option value="/docs/collections/">
+          Collections
+        </option>
+        <option value="/docs/datafiles/">
+          Data Files
+        </option>
+        <option value="/docs/assets/">
+          Assets
+        </option>
+        <option value="/docs/static-files/">
+          Static Files
+        </option>
+    </optgroup>
+    <optgroup label="Site Structure">
+        <option value="/docs/structure/">
+          Directory Structure
+        </option>
+        <option value="/docs/liquid/">
+          Liquid
+        </option>
+        <option value="/docs/variables/">
+          Variables
+        </option>
+        <option value="/docs/includes/">
+          Includes
+        </option>
+        <option value="/docs/layouts/">
+          Layouts
+        </option>
+        <option value="/docs/permalinks/">
+          Permalinks
+        </option>
+        <option value="/docs/themes/">
+          Themes
+        </option>
+        <option value="/docs/pagination/">
+          Pagination
+        </option>
+    </optgroup>
+    <optgroup label="Guides">
+        <option value="/docs/plugins/">
+          Plugins
+        </option>
+        <option value="/docs/migrations/">
+          Blog Migrations
+        </option>
+        <option value="/docs/upgrading/">
+          Upgrading
+        </option>
+        <option value="/docs/deployment/">
+          Deployment
+        </option>
+    </optgroup>
+  </select>
+</div>
+      <div class="unit four-fifths">
+        <article>
+          <div class="improve right hide-on-mobiles">
+            <a data-proofer-ignore href="https://github.com/jekyll/jekyll/edit/master/docs/_docs/plugins/your-first-plugin.md"><i class="fa fa-pencil"></i> &nbsp;Improve this page</a>
+          </div>
+          <h1>Your first plugin</h1>
+          <p>Plugins allow you to extend Jekyll’s behavior to fit your needs. There are six
+types of plugins in Jekyll.</p>
+<h2 id="generators">Generators</h2>
+<p><a href="/docs/plugins/generators/">Generators</a> create content on your site.
+For example:</p>
+<ul>
+  <li><a href="https://github.com/jekyll/jekyll-feed">jekyll-feed</a> creates an Atom feed of
+blog posts.</li>
+  <li><a href="https://github.com/jekyll/jekyll-archives">jekyll-archives</a> creates archive
+pages for blog categories and tags.</li>
+  <li><a href="https://github.com/jekyll/jekyll-sitemap">jekyll-sitemap</a> creates a sitemap.</li>
+</ul>
+<h2 id="converters">Converters</h2>
+<p><a href="/docs/plugins/converters/">Converters</a> change a markup language into another
+format. For example:</p>
+<ul>
+  <li><a href="https://github.com/jekyll/jekyll-textile-converter">jekyll-textile-converter</a>
+converts textile to HTML.</li>
+  <li><a href="https://github.com/jekyll/jekyll-coffeescript">jekyll-coffeescript</a> converts
+Coffeescript to JavaScript.</li>
+  <li><a href="https://github.com/jekyll/jekyll-opal">jekyll-opal</a> converts Ruby to
+JavaScript.</li>
+</ul>
+<h2 id="commands">Commands</h2>
+<p><a href="/docs/plugins/commands/">Commands</a> extend the <code class="highlighter-rouge">jekyll</code> executable with
+subcommands. For example:</p>
+<ul>
+  <li><a href="https://github.com/jekyll/jekyll-compose">jekyll-compose</a> adds subcommands
+for creating a post, page or draft.</li>
+</ul>
+<h2 id="tags">Tags</h2>
+<p><a href="/docs/plugins/tags/">Tags</a> create custom Liquid tags. For example:</p>
+<ul>
+  <li><a href="https://github.com/dommmel/jekyll-youtube">jekyll-youtube</a> embeds a YouTube
+video.</li>
+  <li><a href="https://github.com/samrayner/jekyll-asset-path-plugin">jekyll-asset-path-plugin</a>
+outputs a relative URL for assets.</li>
+  <li><a href="https://github.com/sectore/jekyll-swfobject">jekyll-swfobject</a> embeds a SWF
+object.</li>
+</ul>
+<h2 id="filters">Filters</h2>
+<p><a href="/docs/plugins/filters/">Filters</a> create custom Liquid filters. For example:</p>
+<ul>
+  <li><a href="https://github.com/markets/jekyll-timeago">jekyll-time-ago</a> - The distance
+between two dates in words.</li>
+  <li><a href="https://github.com/toshimaru/jekyll-toc">jekyll-toc</a> - Generates a table of
+content.</li>
+  <li><a href="https://github.com/vwochnik/jekyll-email-protect">jekyll-email-protect</a> -
+Obfuscates emails to protect them from spam bots.</li>
+</ul>
+<h2 id="hooks">Hooks</h2>
+<p><a href="/docs/plugins/hooks/">Hooks</a> give fine-grained control to extend the build
+process.</p>
+<h2 id="flags">Flags</h2>
+<p>There are two flags to be aware of when writing a plugin:</p>
+<div class="mobile-side-scroller">
+<table>
+  <thead>
+    <tr>
+      <th>Flag</th>
+      <th>Description</th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr>
+      <td>
+        <p><code>safe</code></p>
+      </td>
+      <td>
+        <p>
+          A boolean flag that informs Jekyll whether this plugin may be safely
+          executed in an environment where arbitrary code execution is not
+          allowed. This is used by GitHub Pages to determine which core plugins
+          may be used, and which are unsafe to run. If your plugin does not
+          allow for arbitrary code execution, set this to <code>true</code>.
+          GitHub Pages still won’t load your plugin, but if you submit it for
+          inclusion in core, it’s best for this to be correct!
+        </p>
+      </td>
+    </tr>
+    <tr>
+      <td>
+        <p><code>priority</code></p>
+      </td>
+      <td>
+        <p>
+          This flag determines what order the plugin is loaded in. Valid values
+          are: <code>:lowest</code>, <code>:low</code>, <code>:normal</code>,
+          <code>:high</code>, and <code>:highest</code>. Highest priority
+          matches are applied first, lowest priority are applied last.
+        </p>
+      </td>
+    </tr>
+  </tbody>
+</table>
+</div>
+<p>To use one of the example plugins above as an illustration, here is how you’d
+specify these two flags:</p>
+<div class="language-ruby highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="k">module</span> <span class="nn">Jekyll</span>
+  <span class="k">class</span> <span class="nc">UpcaseConverter</span> <span class="o">&lt;</span> <span class="no">Converter</span>
+    <span class="n">safe</span> <span class="kp">true</span>
+    <span class="n">priority</span> <span class="ss">:low</span>
+    <span class="o">...</span>
+  <span class="k">end</span>
+<span class="k">end</span>
+</code></pre></div></div>
+<h2 id="best-practices">Best Practices</h2>
+<p>The guides help you with the specifics of creating plugins. We also have some
+recommended best practices to help structure your plugin.</p>
+<p>We recommend using a <a href="/docs/ruby-101/#gems">gem</a> for your plugin. This will
+help you manage dependencies, keep separation from your site source code and
+allow you to share functionality across multiple projects. For tips on creating
+a gem take a look a the
+<a href="https://guides.rubygems.org/make-your-own-gem/">Ruby gems guide</a> or look
+through the source code of an existing plugin such as
+<a href="https://github.com/jekyll/jekyll-feed">jekyll-feed</a>.</p>
+        </article>
+      </div>
+      <div class="unit one-fifth hide-on-mobiles">
+  <aside>
+      <h4>Getting Started</h4>
+      <ul>
+          <li>
+            <a href="/docs/">
+              Quickstart
+            </a>
+          </li>
+          <li>
+            <a href="/docs/ruby-101/">
+              Ruby 101
+            </a>
+          </li>
+          <li>
+            <a href="/docs/installation/">
+              Installation
+            </a>
+          </li>
+          <li>
+            <a href="/docs/community/">
+              Community
+            </a>
+          </li>
+          <li>
+            <a href="/docs/step-by-step/01-setup/">
+              Step by Step Tutorial
+            </a>
+          </li>
+      </ul>
+      <h4>Build</h4>
+      <ul>
+          <li>
+            <a href="/docs/usage/">
+              Command Line Usage
+            </a>
+          </li>
+          <li>
+            <a href="/docs/configuration/">
+              Configuration
+            </a>
+          </li>
+      </ul>
+      <h4>Content</h4>
+      <ul>
+          <li>
+            <a href="/docs/pages/">
+              Pages
+            </a>
+          </li>
+          <li>
+            <a href="/docs/posts/">
+              Posts
+            </a>
+          </li>
+          <li>
+            <a href="/docs/front-matter/">
+              Front Matter
+            </a>
+          </li>
+          <li>
+            <a href="/docs/collections/">
+              Collections
+            </a>
+          </li>
+          <li>
+            <a href="/docs/datafiles/">
+              Data Files
+            </a>
+          </li>
+          <li>
+            <a href="/docs/assets/">
+              Assets
+            </a>
+          </li>
+          <li>
+            <a href="/docs/static-files/">
+              Static Files
+            </a>
+          </li>
+      </ul>
+      <h4>Site Structure</h4>
+      <ul>
+          <li>
+            <a href="/docs/structure/">
+              Directory Structure
+            </a>
+          </li>
+          <li>
+            <a href="/docs/liquid/">
+              Liquid
+            </a>
+          </li>
+          <li>
+            <a href="/docs/variables/">
+              Variables
+            </a>
+          </li>
+          <li>
+            <a href="/docs/includes/">
+              Includes
+            </a>
+          </li>
+          <li>
+            <a href="/docs/layouts/">
+              Layouts
+            </a>
+          </li>
+          <li>
+            <a href="/docs/permalinks/">
+              Permalinks
+            </a>
+          </li>
+          <li>
+            <a href="/docs/themes/">
+              Themes
+            </a>
+          </li>
+          <li>
+            <a href="/docs/pagination/">
+              Pagination
+            </a>
+          </li>
+      </ul>
+      <h4>Guides</h4>
+      <ul>
+          <li>
+            <a href="/docs/plugins/">
+              Plugins
+            </a>
+          </li>
+          <li>
+            <a href="/docs/migrations/">
+              Blog Migrations
+            </a>
+          </li>
+          <li>
+            <a href="/docs/upgrading/">
+              Upgrading
+            </a>
+          </li>
+          <li>
+            <a href="/docs/deployment/">
+              Deployment
+            </a>
+          </li>
+      </ul>
+  </aside>
+</div>
+      <div class="clear"></div>
+    </div>
+  </section>
+  <footer>
+  <div class="grid">
+    <div class="unit one-third center-on-mobiles">
+      <p>Jekyll is lovingly maintained by the <a href="/team/">core team</a> of volunteers. </p>
+      <p>The contents of this website are <br />&copy;&nbsp;2019 under the terms of the <a href="https://github.com/jekyll/jekyll/blob/master/LICENSE">MIT&nbsp;License</a>.</p>
+    </div>
+    <div class="unit two-thirds align-right center-on-mobiles">
+      <p>
+        Proudly hosted by
+        <a href="https://github.com">
+          <img src="/img/footer-logo.png" width="100" height="30" alt="GitHub • Social coding">
+        </a>
+      </p>
+    </div>
+    <div class="unit two-thirds align-right center-on-mobiles">
+      <p>
+        Jekyll is funded thanks to its
+        <a href="https://github.com/jekyll/jekyll#sponsors">
+          sponsors!
+        </a>
+      </p>
+    </div>
+  </div>
+</footer>
+  <script>
+  var anchorForId = function (id) {
+    var anchor = document.createElement("a");
+    anchor.className = "header-link";
+    anchor.href      = "#" + id;
+    anchor.innerHTML = "<span class=\"sr-only\">Permalink</span><i class=\"fa fa-link\"></i>";
+    anchor.title = "Permalink";
+    return anchor;
+  };
+  var linkifyAnchors = function (level, containingElement) {
+    var headers = containingElement.getElementsByTagName("h" + level);
+    for (var h = 0; h < headers.length; h++) {
+      var header = headers[h];
+      if (typeof header.id !== "undefined" && header.id !== "") {
+        header.appendChild(anchorForId(header.id));
+      }
+    }
+  };
+  document.onreadystatechange = function () {
+    if (this.readyState === "complete") {
+      var contentBlock = document.getElementsByClassName("docs")[0] || document.getElementsByClassName("news")[0];
+      if (!contentBlock) {
+        return;
+      }
+      for (var level = 1; level <= 6; level++) {
+        linkifyAnchors(level, contentBlock);
+      }
+    }
+  };
+</script>
+  <!-- Google Analytics (https://www.google.com/analytics) -->
+  <script>
+    !function(j,e,k,y,l,L){j.GoogleAnalyticsObject=y,j[y]||(j[y]=function(){
+    (j[y].q=j[y].q||[]).push(arguments)}),j[y].l=+new Date,l=e.createElement(k),
+    L=e.getElementsByTagName(k)[0],l.src='https://www.google-analytics.com/analytics.js',
+    L.parentNode.insertBefore(l,L)}(window,document,'script','ga');
+    ga('create', 'UA-50755011-1', 'jekyllrb.com');
+    ga('send', 'pageview');
+  </script>
+  <script type="text/javascript" src="https://cdn.jsdelivr.net/npm/docsearch.js@2/dist/cdn/docsearch.min.js"></script>
+<script type="text/javascript"> docsearch({
+apiKey: '50fe39c839958dfad797000f33e2ec17',
+indexName: 'jekyllrb',
+inputSelector: '#docsearch-input',
+enhancedSearchInput: true,
+debug: false // Set debug to true if you want to inspect the dropdown
+});
+</script>
+</body>
+</html>