site/docs/usage/index.html in jekyll-docs-3.5.2 vs site/docs/usage/index.html in jekyll-docs-3.6.0

- old
+ new

@@ -2,32 +2,32 @@ <html lang="en-US"> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <meta charset="UTF-8"> <meta name="viewport" content="width=device-width,initial-scale=1"> - <meta name="generator" content="Jekyll v3.5.2"> + <meta name="generator" content="Jekyll v3.6.0"> <link type="application/atom+xml" rel="alternate" href="https://jekyllrb.com/feed.xml" title="Jekyll • Simple, blog-aware, static sites"> <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="stylesheet" href="//fonts.googleapis.com/css?family=Lato:300,300italic,400,400italic,700,700italic,900"> <link rel="stylesheet" href="/css/screen.css"> <link rel="icon" type="image/x-icon" href="/favicon.ico"> - <!-- Begin Jekyll SEO tag v2.2.3 --> + <!-- Begin Jekyll SEO tag v2.3.0 --> <title>Basic Usage | Jekyll • Simple, blog-aware, static sites</title> <meta property="og:title" content="Basic Usage"> <meta property="og:locale" content="en_US"> <meta name="description" content="The Jekyll gem makes a jekyll executable available to you in your Terminal window. You can use this command in a number of ways:"> <meta property="og:description" content="The Jekyll gem makes a jekyll executable available to you in your Terminal window. You can use this command in a number of ways:"> <link rel="canonical" href="https://jekyllrb.com/docs/usage/"> <meta property="og:url" content="https://jekyllrb.com/docs/usage/"> <meta property="og:site_name" content="Jekyll • Simple, blog-aware, static sites"> <meta property="og:type" content="article"> -<meta property="article:published_time" content="2017-08-12T13:36:54-07:00"> +<meta property="article:published_time" content="2017-10-24T08:07:43-07:00"> <meta name="twitter:card" content="summary"> <meta name="twitter:site" content="@jekyllrb"> <meta name="google-site-verification" content="onQcXpAvtHBrUI5LlroHNE_FP0b2qvFyPq7VZw36iEY"> <script type="application/ld+json"> -{"@context":"http://schema.org","@type":"BlogPosting","headline":"Basic Usage","datePublished":"2017-08-12T13:36:54-07:00","dateModified":"2017-08-12T13:36:54-07:00","description":"The Jekyll gem makes a jekyll executable available to you in your Terminal window. You can use this command in a number of ways:","publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"https://jekyllrb.com/img/logo-2x.png"}},"mainEntityOfPage":{"@type":"WebPage","@id":"https://jekyllrb.com/docs/usage/"},"url":"https://jekyllrb.com/docs/usage/"}</script> +{"name":null,"description":"The Jekyll gem makes a jekyll executable available to you in your Terminal window. You can use this command in a number of ways:","url":"https://jekyllrb.com/docs/usage/","headline":"Basic Usage","dateModified":"2017-10-24T08:07:43-07:00","datePublished":"2017-10-24T08:07:43-07:00","sameAs":null,"@type":"BlogPosting","author":null,"image":null,"publisher":{"@type":"Organization","logo":{"@type":"ImageObject","url":"https://jekyllrb.com/img/logo-2x.png"}},"mainEntityOfPage":{"@type":"WebPage","@id":"https://jekyllrb.com/docs/usage/"},"@context":"http://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> @@ -288,25 +288,23 @@ </div> <h1>Basic Usage</h1> <p>The Jekyll gem makes a <code class="highlighter-rouge">jekyll</code> executable available to you in your Terminal window. You can use this command in a number of ways:</p> -<div class="language-sh highlighter-rouge"> -<pre class="highlight"><code><span class="gp">$ </span>jekyll build +<div class="language-sh highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>jekyll build <span class="c"># =&gt; The current folder will be generated into ./_site</span> -<span class="gp">$ </span>jekyll build --destination &lt;destination&gt; +<span class="nv">$ </span>jekyll build <span class="nt">--destination</span> &lt;destination&gt; <span class="c"># =&gt; The current folder will be generated into &lt;destination&gt;</span> -<span class="gp">$ </span>jekyll build --source &lt;<span class="nb">source</span>&gt; --destination &lt;destination&gt; +<span class="nv">$ </span>jekyll build <span class="nt">--source</span> &lt;<span class="nb">source</span><span class="o">&gt;</span> <span class="nt">--destination</span> &lt;destination&gt; <span class="c"># =&gt; The &lt;source&gt; folder will be generated into &lt;destination&gt;</span> -<span class="gp">$ </span>jekyll build --watch +<span class="nv">$ </span>jekyll build <span class="nt">--watch</span> <span class="c"># =&gt; The current folder will be generated into ./_site,</span> <span class="c"># watched for changes, and regenerated automatically.</span> -</code></pre> -</div> +</code></pre></div></div> <div class="note info"> <h5>Changes to _config.yml are not included during automatic regeneration.</h5> <p> The <code>_config.yml</code> master configuration file contains global configurations @@ -334,54 +332,46 @@ </div> <p>Jekyll also comes with a built-in development server that will allow you to preview what the generated site will look like in your browser locally.</p> -<div class="language-sh highlighter-rouge"> -<pre class="highlight"><code><span class="gp">$ </span>jekyll serve +<div class="language-sh highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>jekyll serve <span class="c"># =&gt; A development server will run at http://localhost:4000/</span> <span class="c"># Auto-regeneration: enabled. Use `--no-watch` to disable.</span> -<span class="gp">$ </span>jekyll serve --detach +<span class="nv">$ </span>jekyll serve <span class="nt">--detach</span> <span class="c"># =&gt; Same as `jekyll serve` but will detach from the current terminal.</span> <span class="c"># If you need to kill the server, you can `kill -9 1234` where "1234" is the PID.</span> <span class="c"># If you cannot find the PID, then do, `ps aux | grep jekyll` and kill the instance.</span> -</code></pre> -</div> +</code></pre></div></div> <div class="note info"> <h5>Be aware of default behavior</h5> <p> As of version 2.4, the <code>serve</code> command will watch for changes automatically. To disable this, you can use <code>jekyll serve --no-watch</code>, which preserves the old behavior. </p> </div> -<div class="language-sh highlighter-rouge"> -<pre class="highlight"><code><span class="gp">$ </span>jekyll serve --no-watch +<div class="language-sh highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>jekyll serve <span class="nt">--no-watch</span> <span class="c"># =&gt; Same as `jekyll serve` but will not watch for changes.</span> -</code></pre> -</div> +</code></pre></div></div> <p>These are just a few of the available <a href="../configuration/">configuration options</a>. Many configuration options can either be specified as flags on the command line, or alternatively (and more commonly) they can be specified in a <code class="highlighter-rouge">_config.yml</code> file at the root of the source directory. Jekyll will automatically use the options from this file when run. For example, if you place the following lines in your <code class="highlighter-rouge">_config.yml</code> file:</p> -<div class="language-yaml highlighter-rouge"> -<pre class="highlight"><code><span class="s">source</span><span class="pi">:</span> <span class="s">_source</span> -<span class="s">destination</span><span class="pi">:</span> <span class="s">_deploy</span> -</code></pre> -</div> +<div class="language-yaml highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="na">source</span><span class="pi">:</span> <span class="s">_source</span> +<span class="na">destination</span><span class="pi">:</span> <span class="s">_deploy</span> +</code></pre></div></div> <p>Then the following two commands will be equivalent:</p> -<div class="language-sh highlighter-rouge"> -<pre class="highlight"><code><span class="gp">$ </span>jekyll build -<span class="gp">$ </span>jekyll build --source _source --destination _deploy -</code></pre> -</div> +<div class="language-sh highlighter-rouge"><div class="highlight"><pre class="highlight"><code><span class="nv">$ </span>jekyll build +<span class="nv">$ </span>jekyll build <span class="nt">--source</span> _source <span class="nt">--destination</span> _deploy +</code></pre></div></div> <p>For more about the possible configuration options, see the <a href="../configuration/">configuration</a> page.</p> <div class="note info">