hexo-blog-deploy/lib/pace/README.html

33 lines
1.8 KiB
HTML

<h1 align="center"><a href="https://github.com/HubSpot/pace">Progress bar</a> for <a href="https://github.com/theme-next">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><code class="language-sh">$ cd themes/next
$ ls
_config.yml crowdin.yml docs gulpfile.js languages layout LICENSE.md package.json README.md scripts source
</code></pre>
<h2 align="center">Step 2 &rarr; Get module</h2>
<p>Install module to <code>source/lib</code> directory:</p>
<pre><code class="language-sh">$ git clone https://github.com/theme-next/theme-next-pace source/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><code class="language-yml">pace:
enable: true
# Themes list:
# big-counter | bounce | barber-shop | center-atom | center-circle | center-radar | center-simple
# corner-indicator | fill-left | flat-top | flash | loading-bar | mac-osx | material | minimal
theme: minimal
</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">jsdelivr</a>)</p>
<pre><code class="language-yml">vendors:
...
pace: //cdn.jsdelivr.net/npm/pace-js@1/pace.min.js
pace_css: //cdn.jsdelivr.net/npm/pace-js@1/themes/blue/pace-theme-minimal.css
</code></pre>
<h1 align="center">Update</h1>
<pre><code class="language-sh">$ cd themes/next/source/lib/pace
$ git pull
</code></pre>