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 &rarr; 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>
<pre class="highlight"><code class="sh">$ <span class="built_in">cd</span> themes/next
$ ls
_config.yml  crowdin.yml  docs  gulpfile.js  languages  layout  LICENSE.md  package.json  README.md  scripts  <span class="built_in">source</span>
</code></pre>
<h2 align="center">Step 2 &rarr; Get module</h2>
<p>Install module to <code>source/lib</code> directory:</p>
<pre class="highlight"><code class="sh">$ git <span class="built_in">clone</span> https://github.com/theme-next/theme-next-pace <span class="built_in">source</span>/lib/pace
</code></pre>
<h2 align="center">Step 3 &rarr; Set it up</h2>
<p>Enable module in <strong>NexT</strong> <code>_config.yml</code> file and select your theme:</p>
<pre class="highlight"><code class="yml"><span class="attr">pace:</span>
  <span class="attr">enable:</span> <span class="literal">true</span>
  <span class="comment"># Themes list:</span>
  <span class="comment"># big-counter | bounce | barber-shop | center-atom | center-circle | center-radar | center-simple</span>
  <span class="comment"># corner-indicator | fill-left | flat-top | flash | loading-bar | mac-osx | material | minimal</span>
  <span class="attr">theme:</span> <span class="string">minimal</span>
</code></pre>
<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>
<pre class="highlight"><code class="yml"><span class="attr">vendors:</span>
  <span class="string">...</span>
  <span class="attr">pace:</span> <span class="string">//cdn.jsdelivr.net/npm/pace-js@1/pace.min.js</span>
  <span class="attr">pace_css:</span> <span class="string">//cdn.jsdelivr.net/npm/pace-js@1/themes/blue/pace-theme-minimal.css</span>
</code></pre>
<h1 align="center">Update</h1>
<pre class="highlight"><code class="sh">$ <span class="built_in">cd</span> themes/next/<span class="built_in">source</span>/lib/pace
$ git pull
</code></pre>