refactor: enhance the user experience with PJAX

_config.yml

@@ -49,7 +49,9 @@ social_contact:
   links:
     github:          # your GitHub URL
     weixin:          # your WeChat QR-Code URL
+    qq:              # your QQ QR-Code URL
     weibo:           # your WeiBo URL
+    zhihu:           # your ZhiHu URL
     twitter:         # your twitter URL
     facebook:        # your facebook URL
     email:           # your email
@@ -193,6 +195,20 @@ copyright_info:
   enable: true
 
 
+# ---------------------------------------------------------------------------------------
+# CDN
+# ---------------------------------------------------------------------------------------
+cdn:
+  enable: false
+
+
+# ---------------------------------------------------------------------------------------
+# PJAX
+# ---------------------------------------------------------------------------------------
+pjax:
+  enable: false
+
+
 # ---------------------------------------------------------------------------------------
 # Footer settings
 # ---------------------------------------------------------------------------------------
@@ -200,13 +216,6 @@ footer:
   since: 2020
 
 
-# ---------------------------------------------------------------------------------------
-# CDN
-# ---------------------------------------------------------------------------------------
-cdn:
-  enable: true
-
-
 # ---------------------------------------------------------------------------------------
 # Keep version (Please don't modify)
 # ---------------------------------------------------------------------------------------

layout/_partial/comment/gitalk.ejs

@@ -5,16 +5,19 @@
         && theme.comment.gitalk.github_id
         && theme.comment.gitalk.repository
 ) { %>
-    <script src="https://unpkg.com/gitalk/dist/gitalk.min.js"></script>
+    <script <%= theme.pjax.enable === true ? 'data-pjax' : '' %>
+            src="//cdn.jsdelivr.net/npm/gitalk/dist/gitalk.min.js"></script>
     <div id="gitalk-container"></div>
-    <script>
+    <script <%= theme.pjax.enable === true ? 'data-pjax' : '' %>>
+
+        function loadGitalk() {
             let __gitalk__pathname = decodeURI(location.pathname);
             const __gitalk__pathnameLength = __gitalk__pathname.length;
             const __gitalk__pathnameMaxLength = 50;
             if (__gitalk__pathnameLength > __gitalk__pathnameMaxLength) {
                 __gitalk__pathname = __gitalk__pathname.substring(0, __gitalk__pathnameMaxLength - 3) + '...';
             }
-        const gitalk = new Gitalk({
+            new Gitalk({
                 clientID: '<%= theme.comment.gitalk.client_id %>',
                 clientSecret: '<%= theme.comment.gitalk.client_secret %>',
                 repo: '<%= theme.comment.gitalk.repository %>',
@@ -22,7 +25,16 @@
                 admin: ['<%= theme.comment.gitalk.github_id %>'],
                 id: __gitalk__pathname,
                 language: '<%= config.language %>'
-        })
-        gitalk.render('gitalk-container')
+            }).render('gitalk-container');
+        }
+
+        if ('<%= theme.pjax.enable %>') {
+            const loadGitalkTimeout = setTimeout(() => {
+                loadGitalk();
+                clearTimeout(loadGitalkTimeout);
+            }, 1000);
+        } else {
+            window.addEventListener('DOMContentLoaded', loadGitalk);
+        }
     </script>
 <% } %>

layout/_partial/comment/valine.ejs

@@ -4,9 +4,12 @@
         && theme.comment.valine.appkey
 ) { %>
     <div class="valine-container">
-        <script src='//unpkg.com/valine/dist/Valine.min.js'></script>
+        <script <%= theme.pjax.enable === true ? 'data-pjax' : '' %>
+                src="//cdn.jsdelivr.net/npm/valine@latest/dist/Valine.min.js"></script>
         <div id="vcomments"></div>
-        <script>
+        <script <%= theme.pjax.enable === true ? 'data-pjax' : '' %>>
+
+            function loadValine() {
                 const temp_valine_input_meta = '<%= theme.comment.valine.meta %>';
                 new Valine({
                     el: '#vcomments',
@@ -40,6 +43,16 @@
                         clearInterval(getValineDomTimer);
                     }
                 }, 2000);
+            }
+
+            if ('<%= theme.pjax.enable %>') {
+                const loadValineTimeout = setTimeout(() => {
+                    loadValine();
+                    clearTimeout(loadValineTimeout);
+                }, 1000);
+            } else {
+                window.addEventListener('DOMContentLoaded', loadValine);
+            }
         </script>
     </div>
 <% } %>

layout/_partial/footer.ejs

@@ -7,8 +7,8 @@
             <% } %>
             <%= date(new Date(), 'YYYY') %> <i class="fas fa-heart icon-animate"></i> <a href="/"><%= theme.base_info.author || config.author %></a>
         </div>
-        <% if (theme.website_count.busuanzi_count.enable) { %>
-            <script async src="//busuanzi.ibruce.info/busuanzi/2.3/busuanzi.pure.mini.js"></script>
+        <% if (theme.website_count.busuanzi_count.enable === true) { %>
+            <script async <%= theme.pjax.enable === true ? 'data-pjax' : '' %> src="//busuanzi.ibruce.info/busuanzi/2.3/busuanzi.pure.mini.js"></script>
             <div class="website-count info-item">
                 <% if (theme.website_count.busuanzi_count.site_uv) { %>
                     <span id="busuanzi_container_site_uv">

layout/_partial/pjax/pjax.ejs

@@ -0,0 +1,21 @@
+<%- __js('js/libs/pjax.min.js') %>
+<script>
+    window.addEventListener('DOMContentLoaded', () => {
+        const pjax = new Pjax({
+            selectors: [
+                'head title',
+                '.page-container',
+                '.pjax',
+            ],
+            cacheBust: false,
+            currentUrlFullReload: false,
+            timeout: 0
+        });
+
+        window.addEventListener('pjax:complete', () => {
+
+            KEEP.refresh();
+            pjax.executeScripts(document.querySelectorAll('script[data-pjax], .pjax script'));
+        });
+    });
+</script>

layout/_partial/scripts.ejs

@@ -10,15 +10,20 @@
     <%- __js('js/local-search.js') %>
 <% } %>
 
-<% if (is_post()) { %>
-
-    <%- __js('js/left-side-toggle.js') %>
-
 <% if (theme.code_copy.enable) { %>
     <%- __js('js/code-copy.js') %>
 <% } %>
 
-    <% if (theme.toc.enable) { %>
-        <%- __js(['js/libs/anime.min.js', 'js/toc.js']) %>
+<div class="post-scripts <%= theme.pjax.enable === true ? 'pjax' : '' %>">
+    <% if (theme.toc.enable && is_post()) { %>
+        <%- __js([
+            'js/left-side-toggle.js',
+            'js/libs/anime.min.js',
+            'js/toc.js'
+        ]) %>
     <% } %>
+</div>
+
+<% if (theme.pjax.enable === true) { %>
+    <%- partial('pjax/pjax') %>
 <% } %>

scripts/helpers/export-config.js

@@ -14,7 +14,7 @@ hexo.extend.helper.register('export_config', function () {
 
   let {config, theme} = this;
 
-  // ------ export language to js ------
+  // ------------ export language to js ------------
   const languageDir = path.join(__dirname, '../../languages');
   let file = fs.readdirSync(languageDir).find(v => v === `${config.language}.yml`);
   file = languageDir + '/' + (file ? file : 'en.yml');
@@ -24,14 +24,14 @@ hexo.extend.helper.register('export_config', function () {
   } catch (e) {
     console.log(e);
   }
-  // ---------------------------------
-
+  // -----------------------------------------------
 
 
   let hexo_config = {
     hostname: url.parse(config.url).hostname || config.url,
     root: config.root
   };
+
   if (config.search) {
     hexo_config.path = config.search.path;
   }
@@ -41,6 +41,7 @@ hexo.extend.helper.register('export_config', function () {
     style: theme.style,
     local_search: theme.local_search,
     side_tools: theme.side_tools,
+    pjax: theme.pjax,
     version: theme.version,
   }
 
@@ -48,6 +49,6 @@ hexo.extend.helper.register('export_config', function () {
     let KEEP = window.KEEP || {};
     KEEP.hexo_config = ${JSON.stringify(hexo_config)};
     KEEP.theme_config = ${JSON.stringify(theme_config)};
-    KEEP.language = ${JSON.stringify(languageContent)};
+    KEEP.language_ago = ${JSON.stringify(languageContent['ago'])};
   </script>`;
 });

source/js/back2top.js

@@ -1,4 +1,5 @@
-window.addEventListener('DOMContentLoaded', () => {
+KEEP.initBack2Top = () => {
+
   KEEP.utils = {
 
     ...KEEP.utils,
@@ -49,4 +50,5 @@ window.addEventListener('DOMContentLoaded', () => {
 
   KEEP.utils.initBack2Top();
   KEEP.utils.initBack2Bottom();
-});
+
+}

source/js/code-copy.js

@@ -1,20 +1,21 @@
+KEEP.initCodeCopy = () => {
+
   HTMLElement.prototype.wrap = function (wrapper) {
     this.parentNode.insertBefore(wrapper, this);
     this.parentNode.removeChild(this);
     wrapper.appendChild(this);
   };
 
-window.addEventListener('DOMContentLoaded', () => {
   document.querySelectorAll('figure.highlight').forEach(element => {
     const box = document.createElement('div');
     element.wrap(box);
     box.classList.add('highlight-container');
     box.insertAdjacentHTML('beforeend', '<div class="copy-btn"><i class="fas fa-copy"></i></div>');
-    var button = element.parentNode.querySelector('.copy-btn');
+    const button = element.parentNode.querySelector('.copy-btn');
     button.addEventListener('click', event => {
-      var target = event.currentTarget;
-      var code = [...target.parentNode.querySelectorAll('.code .line')].map(line => line.innerText).join('\n');
-      var ta = document.createElement('textarea');
+      const target = event.currentTarget;
+      const code = [...target.parentNode.querySelectorAll('.code .line')].map(line => line.innerText).join('\n');
+      const ta = document.createElement('textarea');
       ta.style.top = window.scrollY + 'px'; // Prevent page scrolling
       ta.style.position = 'absolute';
       ta.style.opacity = '0';
@@ -26,7 +27,7 @@ window.addEventListener('DOMContentLoaded', () => {
       ta.select();
       ta.setSelectionRange(0, code.length);
       ta.readOnly = false;
-      var result = document.execCommand('copy');
+      const result = document.execCommand('copy');
       target.querySelector('i').className = result ? 'fas fa-check' : 'fas fa-times';
       ta.blur(); // For iOS
       target.blur();
@@ -42,4 +43,4 @@ window.addEventListener('DOMContentLoaded', () => {
       }, 300);
     });
   });
-});
+}

source/js/dark-light-toggle.js

@@ -1,4 +1,5 @@
-window.addEventListener('DOMContentLoaded', () => {
+KEEP.initModeToggle = () => {
+
   KEEP.utils.modeToggle = {
 
     localStorageKey: 'KEEP',
@@ -68,4 +69,5 @@ window.addEventListener('DOMContentLoaded', () => {
 
   KEEP.utils.modeToggle.initModeStatus();
   KEEP.utils.modeToggle.initModeToggleButton();
-});
+
+};

source/js/header-shrink.js

@@ -1,4 +1,4 @@
-window.addEventListener('DOMContentLoaded', () => {
+KEEP.initHeaderShrink = () => {
   KEEP.utils.headerShrink = {
 
     pageTemplateDom: document.querySelector('.page-main-content'),
@@ -45,4 +45,4 @@ window.addEventListener('DOMContentLoaded', () => {
   KEEP.utils.headerShrink.init();
   KEEP.utils.headerShrink.initMenuBarButton();
   KEEP.utils.headerShrink.initWindowMask();
-});
+}

source/js/left-side-toggle.js

@@ -1,5 +1,4 @@
-window.addEventListener('DOMContentLoaded', () => {
-
+function initLeftSideToggle() {
   KEEP.utils.leftSideToggle = {
 
     init() {
@@ -34,8 +33,12 @@ window.addEventListener('DOMContentLoaded', () => {
       this.leftAsideDom.style.left = isOpen ? '0' : `-${pageAsideWidth}`;
     },
   }
-
   KEEP.utils.leftSideToggle.init();
   KEEP.utils.leftSideToggle.initToggleBarButton();
+}
 
-});
+if (KEEP.theme_config.pjax && KEEP.utils) {
+  initLeftSideToggle();
+} else {
+  window.addEventListener('DOMContentLoaded', initLeftSideToggle);
+}

source/js/local-search.js

@@ -1,5 +1,4 @@
-/* global CONFIG */
-window.addEventListener('DOMContentLoaded', () => {
+KEEP.initLocalSearch = () => {
 
   // Search DB path
   let searchPath = KEEP.hexo_config.path;
@@ -251,7 +250,8 @@ window.addEventListener('DOMContentLoaded', () => {
           return data;
         });
         // Remove loading animation
-        document.getElementById('no-result').innerHTML = '<i class="fas fa-search fa-5x"></i>';
+        const noResultDom = document.querySelector('#no-result');
+        noResultDom && (noResultDom.innerHTML = '<i class="fas fa-search fa-5x"></i>');
       });
   };
 
@@ -301,4 +301,5 @@ window.addEventListener('DOMContentLoaded', () => {
       onPopupClose();
     }
   });
-});
+
+}

source/js/main.js

@@ -7,32 +7,14 @@ window.addEventListener('DOMContentLoaded', () => {
     repository: 'https://github.com/XPoet/hexo-theme-keep'
   }
 
-  // print theme info
-  KEEP.utils.printThemeInfo();
+  KEEP.refresh = () => {
+    KEEP.initUtils();
+    KEEP.initHeaderShrink();
+    KEEP.initModeToggle();
+    KEEP.initLocalSearch();
+    KEEP.initBack2Top();
+    KEEP.initCodeCopy();
+  }
 
-  // init scroll
-  KEEP.utils.registerWindowScroll();
-
-  // toggle show tools list
-  KEEP.utils.toggleShowToolsList();
-
-  // global font adjust
-  KEEP.utils.globalFontAdjust();
-
-  KEEP.utils.contentAreaWidthAdjust();
-
-  // comment
-  KEEP.utils.goComment();
-
-  // init page height handle
-  KEEP.utils.initPageHeightHandle();
-
-  // init first screen height
-  KEEP.utils.initFirstScreenHeight();
-
-  // big image viewer handle
-  KEEP.utils.imageViewer();
-
-  // set how long age in home article block
-  KEEP.utils.setHowLongAgoInHome();
+  KEEP.refresh();
 });

source/js/toc.js

@@ -1,11 +1,7 @@
-window.addEventListener('DOMContentLoaded', () => {
-
+function initTOC() {
   KEEP.utils.navItems = document.querySelectorAll('.post-toc-wrap .post-toc li');
-  KEEP.utils.articleToc_dom = document.querySelector('.article-toc');
-  KEEP.utils.postTocWrap_dom = document.querySelector('.post-toc-wrap');
 
   if (KEEP.utils.navItems.length > 0) {
-
     KEEP.utils = {
 
       ...KEEP.utils,
@@ -74,21 +70,15 @@ window.addEventListener('DOMContentLoaded', () => {
         KEEP.utils.leftSideToggle.changePageLayoutWhenOpenToggle(KEEP.utils.leftSideToggle.isOpenPageAside);
       }
     }
-
     KEEP.utils.showPageAsideWhenHasTOC();
     KEEP.utils.registerSidebarTOC();
-
-
   } else {
-
-    if (KEEP.utils.postTocWrap_dom) {
-      KEEP.utils.postTocWrap_dom.innerHTML = '';
-      KEEP.utils.postTocWrap_dom.style.display = 'none';
-    }
-
-    if (KEEP.utils.articleToc_dom) {
-      KEEP.utils.articleToc_dom.style.display = 'none';
+    KEEP.utils.pageContainer_dom.removeChild(document.querySelector('.page-aside'));
   }
 }
-});
 
+if (KEEP.theme_config.pjax && KEEP.utils) {
+  initTOC();
+} else {
+  window.addEventListener('DOMContentLoaded', initTOC);
+}

source/js/utils.js

@@ -1,9 +1,12 @@
+KEEP.initUtils = () => {
+
   KEEP.utils = {
 
+    html_root_dom: document.querySelector('html'),
+    pageContainer_dom: document.querySelector('.page-container'),
     headerProgress_dom: document.querySelector('.header-progress'),
     pageTop_dom: document.querySelector('.page-main-content-top'),
     firstScreen_dom: document.querySelector('.first-screen-container'),
-  html_root_dom: document.querySelector('html'),
 
     innerHeight: window.innerHeight,
     prevScrollValue: 0,
@@ -177,14 +180,18 @@ KEEP.utils = {
       });
 
       const imgDoms = document.querySelectorAll('.markdown-body img');
-    imgDoms && imgDoms.forEach(img => {
 
+      if (imgDoms.length) {
+        imgDoms.forEach(img => {
           img.addEventListener('click', () => {
             isBigImage = true;
             showHandle(imageViewerDom, isBigImage);
             targetImg.setAttribute('src', img.getAttribute('src'))
           });
         });
+      } else {
+        this.pageContainer_dom.removeChild(imageViewerDom)
+      }
     },
 
     // set how long ago language
@@ -194,7 +201,7 @@ KEEP.utils = {
 
     getHowLongAgo(timestamp) {
 
-    let l = KEEP.language
+      let l = KEEP.language_ago;
 
       timestamp /= 1000;
 
@@ -207,25 +214,25 @@ KEEP.utils = {
       const __s = Math.floor(timestamp % 60)
 
       if (__Y > 0) {
-      return this.setHowLongAgoLanguage(__Y, l.ago.year)
+        return this.setHowLongAgoLanguage(__Y, l.year)
 
       } else if (__M > 0) {
-      return this.setHowLongAgoLanguage(__M, l.ago.month)
+        return this.setHowLongAgoLanguage(__M, l.month)
 
       } else if (__W > 0) {
-      return this.setHowLongAgoLanguage(__W, l.ago.week)
+        return this.setHowLongAgoLanguage(__W, l.week)
 
       } else if (__d > 0) {
-      return this.setHowLongAgoLanguage(__d, l.ago.day)
+        return this.setHowLongAgoLanguage(__d, l.day)
 
       } else if (__h > 0) {
-      return this.setHowLongAgoLanguage(__h, l.ago.hour)
+        return this.setHowLongAgoLanguage(__h, l.hour)
 
       } else if (__m > 0) {
-      return this.setHowLongAgoLanguage(__m, l.ago.minute)
+        return this.setHowLongAgoLanguage(__m, l.minute)
 
       } else if (__s > 0) {
-      return this.setHowLongAgoLanguage(__s, l.ago.second)
+        return this.setHowLongAgoLanguage(__s, l.second)
       }
     },
 
@@ -236,3 +243,35 @@ KEEP.utils = {
       })
     }
   }
+
+  // print theme info
+  KEEP.utils.printThemeInfo();
+
+  // init scroll
+  KEEP.utils.registerWindowScroll();
+
+  // toggle show tools list
+  KEEP.utils.toggleShowToolsList();
+
+  // global font adjust
+  KEEP.utils.globalFontAdjust();
+
+  // adjust content area width
+  KEEP.utils.contentAreaWidthAdjust();
+
+  // go comment
+  KEEP.utils.goComment();
+
+  // init page height handle
+  KEEP.utils.initPageHeightHandle();
+
+  // init first screen height
+  KEEP.utils.initFirstScreenHeight();
+
+  // big image viewer handle
+  KEEP.utils.imageViewer();
+
+  // set how long age in home article block
+  KEEP.utils.setHowLongAgoInHome();
+
+}