public/lib/pace/README.html

<h1 align="center">
<a href="https://github.com/HubSpot/pace" target="_blank" rel="noopener">Progress bar</a> for <a href="https://github.com/theme-next" target="_blank" rel="noopener">NexT</a>
</h1>
<h1 align="center">
Installation
</h1>
<h2>
If you want to use the CDN instead of clone this repo, please jump to the Step 3.
</h2>
<h2 align="center">
Step 1 → Go to NexT dir
</h2>
<p>Change dir to <strong>NexT</strong> directory. There must be <code>layout</code>, <code>source</code>, <code>languages</code> and other directories:</p>
<div class="sourceCode" id="cb1"><pre class="sourceCode sh"><code class="sourceCode bash"><span id="cb1-1"><a href="#cb1-1"></a>$ <span class="bu">cd</span> themes/next</span>
<span id="cb1-2"><a href="#cb1-2"></a>$ <span class="fu">ls</span></span>
<span id="cb1-3"><a href="#cb1-3"></a><span class="ex">_config.yml</span>  crowdin.yml  docs  gulpfile.js  languages  layout  LICENSE.md  package.json  README.md  scripts  source</span></code></pre></div>
<h2 align="center">
Step 2 → Get module
</h2>
<p>Install module to <code>source/lib</code> directory:</p>
<div class="sourceCode" id="cb2"><pre class="sourceCode sh"><code class="sourceCode bash"><span id="cb2-1"><a href="#cb2-1"></a>$ <span class="fu">git</span> clone https://github.com/theme-next/theme-next-pace source/lib/pace</span></code></pre></div>
<h2 align="center">
Step 3 → Set it up
</h2>
<p>Enable module in <strong>NexT</strong> <code>_config.yml</code> file and select your theme:</p>
<div class="sourceCode" id="cb3"><pre class="sourceCode yml"><code class="sourceCode yaml"><span id="cb3-1"><a href="#cb3-1"></a><span class="fu">pace</span><span class="kw">:</span></span>
<span id="cb3-2"><a href="#cb3-2"></a><span class="at">  </span><span class="fu">enable</span><span class="kw">:</span><span class="at"> </span><span class="ch">true</span></span>
<span id="cb3-3"><a href="#cb3-3"></a><span class="co">  # Themes list:</span></span>
<span id="cb3-4"><a href="#cb3-4"></a><span class="co">  # big-counter | bounce | barber-shop | center-atom | center-circle | center-radar | center-simple</span></span>
<span id="cb3-5"><a href="#cb3-5"></a><span class="co">  # corner-indicator | fill-left | flat-top | flash | loading-bar | mac-osx | material | minimal</span></span>
<span id="cb3-6"><a href="#cb3-6"></a><span class="at">  </span><span class="fu">theme</span><span class="kw">:</span><span class="at"> minimal</span></span></code></pre></div>
<p><strong>And, if you wants to use the CDN, then need to set:</strong> (you also need to find your corresponding theme css link in <a href="https://www.jsdelivr.com/package/npm/pace-js?path=themes" target="_blank" rel="noopener">jsdelivr</a>)</p>
<div class="sourceCode" id="cb4"><pre class="sourceCode yml"><code class="sourceCode yaml"><span id="cb4-1"><a href="#cb4-1"></a><span class="fu">vendors</span><span class="kw">:</span></span>
<span id="cb4-2"><a href="#cb4-2"></a><span class="at">  ...</span></span>
<span id="cb4-3"><a href="#cb4-3"></a><span class="at">  </span><span class="fu">pace</span><span class="kw">:</span><span class="at"> //cdn.jsdelivr.net/npm/pace-js@1/pace.min.js</span></span>
<span id="cb4-4"><a href="#cb4-4"></a><span class="at">  </span><span class="fu">pace_css</span><span class="kw">:</span><span class="at"> //cdn.jsdelivr.net/npm/pace-js@1/themes/blue/pace-theme-minimal.css</span></span></code></pre></div>
<h1 align="center">
Update
</h1>
<div class="sourceCode" id="cb5"><pre class="sourceCode sh"><code class="sourceCode bash"><span id="cb5-1"><a href="#cb5-1"></a>$ <span class="bu">cd</span> themes/next/source/lib/pace</span>
<span id="cb5-2"><a href="#cb5-2"></a>$ <span class="fu">git</span> pull</span></code></pre></div>