hexo-theme-shokax 0.3.13 → 0.4.0-alpha.1

package/scripts/helpers/symbols_count_time.ts

@@ -0,0 +1,76 @@
+'use strict'
+/* global hexo */
+/*!
+  hexo-symbols-count-time by theme-next
+  under GNU Lesser General Public License v3.0 or later
+  https://github.com/theme-next/hexo-symbols-count-time/blob/master/LICENSE
+ */
+
+import { stripHTML } from 'hexo-util'
+
+const config = hexo.config.symbols_count_time = Object.assign({
+  symbols: true,
+  time: true,
+  total_symbols: true,
+  total_time: true,
+  exclude_codeblock: false,
+  awl: 4,
+  wpm: 275,
+  suffix: 'mins.'
+}, hexo.config.symbols_count_time)
+
+function getSymbols (post) {
+  return post?._content?.length ?? post?.content?.length ?? post.length
+}
+
+function getSymbolsTotal (site) {
+  let symbolsResultCount = 0
+  site.posts.forEach((post) => {
+    symbolsResultCount += getSymbols(post)
+  })
+  return symbolsResultCount
+}
+
+function getFormatTime (minutes, suffix) {
+  const fHours = Math.floor(minutes / 60)
+  let fMinutes = Math.floor(minutes - (fHours * 60))
+  if (fMinutes < 1) {
+    fMinutes = 1 // 0 => 1
+  }
+  return fHours < 1
+    ? fMinutes + ' ' + suffix // < 59 => 59 mins.
+    : fHours + ':' + ('00' + fMinutes).slice(-2) // = 61 => 1:01
+}
+
+hexo.extend.helper.register('symbolsCount', function (post) {
+  let symbolsResult = getSymbols(post)
+  if (symbolsResult > 9999) {
+    symbolsResult = Math.round(symbolsResult / 1000) + 'k' // > 9999 => 11k
+  } else if (symbolsResult > 999) {
+    symbolsResult = Math.round(symbolsResult / 100) / 10 + 'k' // > 999 => 1.1k
+  } // < 999 => 111
+  return symbolsResult
+})
+
+hexo.extend.helper.register('symbolsTime', function (post, awl = config.awl, wpm = config.wpm, suffix = config.suffix) {
+  const minutes = Math.round(getSymbols(post) / (awl * wpm))
+  return getFormatTime(minutes, suffix)
+})
+
+hexo.extend.helper.register('symbolsCountTotal', function (site) {
+  const symbolsResultTotal = getSymbolsTotal(site)
+  return symbolsResultTotal < 1000000
+    ? Math.round(symbolsResultTotal / 1000) + 'k' // < 999k => 111k
+    : Math.round(symbolsResultTotal / 100000) / 10 + 'm' // > 999k => 1.1m
+})
+
+hexo.extend.helper.register('symbolsTimeTotal', function (site, awl = config.awl, wpm = config.wpm, suffix = config.suffix) {
+  const minutes = Math.round(getSymbolsTotal(site) / (awl * wpm))
+  return getFormatTime(minutes, suffix)
+})
+
+hexo.extend.filter.register('after_post_render', (data) => {
+  let { content } = data
+  if (config.exclude_codeblock) content = content.replace(/<pre>.*?<\/pre>/g, '')
+  data.length = stripHTML(content).replace(/\r?\n|\r/g, '').replace(/\s+/g, '').length
+}, 0)

package/scripts/plugin/check.d.ts

@@ -0,0 +1 @@
+declare let findProblem: boolean;

package/scripts/plugin/check.ts

@@ -0,0 +1,35 @@
+/* global hexo */
+
+let findProblem = false
+
+hexo.on('generateBefore', function () {
+  if (hexo.config.syntax_highlighter) {
+    findProblem = true
+    hexo.log.error('[SXEC 101] Highlight.js or Prismjs enabled. The code block will render incomplete')
+  }
+  if (!hexo.config.markdown) {
+    findProblem = true
+    hexo.log.error(`[SXEC 102] Critical rendering plugins are missing or incorrectly configured. 
+Some features will be disabled or render incorrectly`)
+  }
+  if (parseInt(process.version.match(/\d{2,3}/)[0]) < 18) {
+    findProblem = true
+    hexo.log.error('[SXEC 103] Too old Node.js version, install the latest LTS version')
+  }
+  if (!hexo.config.title || !hexo.config.description || !hexo.config.language || !hexo.config.timezone || !hexo.config.url) {
+    findProblem = true
+    hexo.log.warn('[SXEC 201] Essential information(title, desc, lang, etc) config incorrectly, Page will render incorrectly')
+  }
+  if (hexo.theme.config.gitalk?.clientID || hexo.theme.config.giscus?.repo) {
+    findProblem = true
+    hexo.log.warn('[SXEC 202] You are using an deprecated feature and it was removed in the v0.3.10')
+  }
+})
+
+hexo.on('generateAfter', function () {
+  if (findProblem) {
+    hexo.log.warn(`The environment check found some problems that can lead to rendering errors, effect errors, 
+performance degradation, not working correctly, etc`)
+    hexo.log.warn('ShokaX has output them into console, read them to get more information. You can search error code in docs(For example, SXEC 101)')
+  }
+})

package/scripts/plugin/index.d.ts

@@ -0,0 +1,6 @@
+/*!
+  index.js in next-theme/hexo-theme-next by next-theme
+  under GNU AFFERO GENERAL PUBLIC LICENSE v3.0 OR LATER
+  https://github.com/next-theme/hexo-theme-next/blob/master/LICENSE.md
+ */
+export {};

package/scripts/plugin/index.ts

@@ -0,0 +1,52 @@
+/*!
+  index.js in next-theme/hexo-theme-next by next-theme
+  under GNU AFFERO GENERAL PUBLIC LICENSE v3.0 OR LATER
+  https://github.com/next-theme/hexo-theme-next/blob/master/LICENSE.md
+ */
+
+import injects from './lib/injects'
+import { version } from '../../package.json'
+import * as fs from 'node:fs'
+
+hexo.on('generateBefore', () => {
+  // 加载`theme_injects`过滤器
+  injects(hexo)
+  if (fs.existsSync('request.lock')) {
+    fs.unlinkSync('request.lock')
+  }
+  if (fs.existsSync('requested.lock')) {
+    fs.unlinkSync('requested.lock')
+  }
+})
+
+hexo.on('generateAfter', () => {
+  // 检查版本更新
+  fetch('https://api.github.com/repos/theme-shoka-x/hexo-theme-shokaX/releases/latest').then((res) => {
+    res.json().then((resp) => {
+      try {
+        const latest = resp.tag_name.replace('v', '').split('.')
+        const current = version.split('.')
+        let isOutdated = false
+        for (let i = 0; i < Math.max(latest.length, current.length); i++) {
+          if (!current[i] || latest[i] > current[i]) {
+            isOutdated = true
+            break
+          }
+          if (latest[i] < current[i]) {
+            break
+          }
+        }
+        if (isOutdated) {
+          hexo.log.warn(`Your theme ShokaX is outdated. Current version: v${current.join('.')}, latest version: v${latest.join('.')}`)
+          hexo.log.warn('Visit https://github.com/theme-shoka-x/hexo-theme-shokaX/releases for more information.')
+        }
+      } catch (e) {
+        hexo.log.warn('Failed to detect version info. Error message:')
+        hexo.log.warn(e)
+      }
+    }).catch((e) => {
+      hexo.log.warn('Failed to detect version info. Error message:')
+      hexo.log.warn(e)
+    })
+  })
+})

package/scripts/plugin/lib/injects-point.d.ts

@@ -0,0 +1,5 @@
+declare const _default: {
+    views: string[];
+    styles: string[];
+};
+export default _default;

package/scripts/plugin/lib/injects-point.ts

@@ -0,0 +1,20 @@
+'use strict'
+
+export default {
+  views: [
+    'head',
+    'sidebar',
+    'rightNav',
+    'postMeta',
+    'postBodyEnd',
+    'footer',
+    'bodyEnd',
+    'comment',
+    'status'
+  ],
+  styles: [
+    'variable',
+    'mixin',
+    'style'
+  ]
+}

package/scripts/plugin/lib/injects.d.ts

@@ -0,0 +1,2 @@
+declare const _default: (hexo: any) => void;
+export default _default;

package/scripts/plugin/lib/injects.ts

@@ -0,0 +1,101 @@
+'use strict'
+
+/*!
+  inject.js in next-theme/hexo-theme-next by next-theme
+  under GNU AFFERO GENERAL PUBLIC LICENSE v3.0 OR LATER
+  https://github.com/next-theme/hexo-theme-next/blob/master/LICENSE.md
+ */
+import fs from 'node:fs'
+import path from 'node:path'
+import points from './injects-point'
+const defaultExtname = '.pug'
+
+interface viewConfig {
+  layout: string,
+  locals: object,
+  options: object,
+  order: number
+}
+class StylusInject {
+  files: Array<string>
+  base_dir: string
+  constructor (base_dir) {
+    this.base_dir = base_dir
+    this.files = []
+  }
+
+  push (file) {
+    this.files.push(path.resolve(this.base_dir, file))
+  }
+}
+
+// Defining view types
+class ViewInject {
+  base_dir:string
+  raws: Array<object>
+  constructor (base_dir) {
+    this.base_dir = base_dir
+    this.raws = []
+  }
+
+  raw (name, raw, ...args) {
+    // Set default extname
+    if (path.extname(name) === '') {
+      name += defaultExtname
+    }
+    this.raws.push({ name, raw, args })
+  }
+
+  file (name, file, ...args) {
+    // Set default extname from file's extname
+    if (path.extname(name) === '') {
+      name += path.extname(file)
+    }
+    // Get absolute path base on hexo dir
+    this.raw(name, fs.readFileSync(path.resolve(this.base_dir, file), 'utf8'), ...args)
+  }
+}
+
+// Init injects
+function initInject (base_dir) {
+  const injects = {}
+  points.styles.forEach(item => {
+    injects[item] = new StylusInject(base_dir)
+  })
+  points.views.forEach(item => {
+    injects[item] = new ViewInject(base_dir)
+  })
+  return injects
+}
+
+export default (hexo) => {
+  // Exec theme_inject filter
+  const injects = initInject(hexo.base_dir)
+  hexo.execFilterSync('theme_inject', injects)
+  hexo.theme.config.injects = {}
+
+  // Inject stylus
+  points.styles.forEach(type => {
+    hexo.theme.config.injects[type] = injects[type].files
+  })
+
+  // Inject views
+  points.views.forEach(type => {
+    const configs = Object.create(null)
+    hexo.theme.config.injects[type] = []
+    // Add or override view.
+    injects[type].raws.forEach((injectObj, index) => {
+      const name = `inject/${type}/${injectObj.name}`
+      hexo.theme.setView(name, injectObj.raw)
+      configs[name] = {
+        layout: name,
+        locals: injectObj.args[0],
+        options: injectObj.args[1],
+        order: injectObj.args[2] || index
+      }
+    })
+    // Views sort.
+    hexo.theme.config.injects[type] = Object.values(configs)
+      .sort((x:viewConfig, y:viewConfig) => x.order - y.order)
+  })
+}

package/scripts/tags/links.d.ts

@@ -0,0 +1 @@
+export {};

package/scripts/tags/links.ts

@@ -0,0 +1,75 @@
+import fs from 'node:fs'
+import path from 'node:path'
+import yaml from 'js-yaml'
+
+/*
+{% links %}
+- site: #main title
+  owner: #alternate title for image tooltip (nullable)
+  url: #link of site
+  desc: #description (nullable)
+  image: #icon image (nullable)
+  color: #block color (nullable)
+{% endlinks %}
+
+{% linksfile [path] %}
+*/
+
+interface siteLink {
+  site: string
+  owner?: string
+  url: string
+  desc?: string
+  image?: string
+  color?: string
+}
+
+function linkGrid (args:string[], content:string) {
+  const theme = hexo.theme.config as any
+
+  if (!args[0] && !content) {
+    return
+  }
+
+  if (args[0]) {
+    const filepath = path.join(hexo.source_dir, args[0])
+    if (fs.existsSync(filepath)) {
+      content = fs.readFileSync(filepath, { encoding: 'utf-8' })
+    }
+  }
+
+  if (!content) {
+    return
+  }
+
+  const list = yaml.load(content) as Array<siteLink>
+
+  let result = ''
+
+  list.forEach((item) => {
+    if (!item.url || !item.site) {
+      return
+    }
+
+    let item_image = item.image || theme.assets + '/404.png'
+
+    if (!item_image.startsWith('//') && !item_image.startsWith('http')) {
+      item_image = theme.statics + item_image
+    }
+
+    item.color = item.color ? ` style="--block-color:${item.color};"` : ''
+
+    result += `<div class="item" title="${item.owner || item.site}"${item.color}>`
+
+    result += `<a href="${item.url}" class="image" data-background-image="${item_image}"></a>
+        <div class="info">
+        <a href="${item.url}" class="title">${item.site}</a>
+        <p class="desc">${item.desc || item.url}</p>
+        </div></div>`
+  })
+
+  return `<div class="links">${result}</div>`
+}
+
+hexo.extend.tag.register('links', linkGrid, { ends: true })
+hexo.extend.tag.register('linksfile', linkGrid, { ends: false, async: true })

package/scripts/tags/media.d.ts

@@ -0,0 +1 @@
+export {};

package/scripts/tags/media.ts

@@ -0,0 +1,19 @@
+'use strict'
+/* global hexo */
+import yaml from 'js-yaml'
+
+function postMedia (args, content) {
+  if (!args[0] || !content) {
+    return
+  }
+  const list = yaml.load(content)
+  switch (args[0]) {
+    case 'video':
+    case 'audio':
+      return `<div class="media-container"><div class="player" data-type="${args[0]}" data-src='${JSON.stringify(list)}'></div></div>`
+  }
+}
+
+hexo.extend.tag.register('media', postMedia, { ends: true })
+
+//   return `<video src="${args}" preload="metadata" controls playsinline poster="">Sorry, your browser does not support the video tag.</video>`;

package/source/js/_app/components/sidebar.ts

@@ -0,0 +1,237 @@
+/* 边栏分区 */
+
+import { Container, diffY, menuToggle, showContents, sideBar } from '../globals/globalVars'
+import { clipBoard } from '../globals/tools'
+import { pageScroll, transition } from '../library/anime'
+import { $dom } from '../library/dom'
+
+export const sideBarToggleHandle = (event:Event, force?:number) => {
+  if (sideBar.hasClass('on')) {
+    sideBar.removeClass('on')
+    menuToggle.removeClass('close')
+    if (force) {
+      // @ts-ignore
+      // noinspection JSConstantReassignment
+      sideBar.style = ''
+    } else {
+      transition(sideBar, 'slideRightOut')
+    }
+  } else {
+    if (force) {
+      // @ts-ignore
+      // noinspection JSConstantReassignment
+      sideBar.style = ''
+    } else {
+      transition(sideBar, 'slideRightIn', () => {
+        sideBar.addClass('on')
+        menuToggle.addClass('close')
+      })
+    }
+  }
+}
+
+export const sideBarTab = () => {
+  const sideBarInner = sideBar.child('.inner')
+
+  if (sideBar.child('.tab')) {
+    sideBarInner.removeChild(sideBar.child('.tab'))
+  }
+
+  const list = document.createElement('ul'); let active = 'active'
+  list.className = 'tab';
+
+  ['contents', 'related', 'overview'].forEach((item) => {
+    const element = sideBar.child('.panel.' + item)
+
+    if (element.innerHTML.trim().length < 1) {
+      if (item === 'contents') {
+        showContents.display('none')
+      }
+      return
+    }
+
+    if (item === 'contents') {
+      showContents.display('')
+    }
+
+    const tab = document.createElement('li')
+    const span = document.createElement('span')
+    const text = document.createTextNode(element.getAttribute('data-title'))
+    span.appendChild(text)
+    tab.appendChild(span)
+    tab.addClass(item + ' item')
+
+    if (active) {
+      element.addClass(active)
+      tab.addClass(active)
+    } else {
+      element.removeClass('active')
+    }
+    tab.addEventListener('click', (event) => {
+      const target = event.currentTarget as HTMLElement
+      if (target.hasClass('active')) return
+
+      sideBar.find('.tab .item').forEach((element) => {
+        element.removeClass('active')
+      })
+
+      sideBar.find('.panel').forEach((element) => {
+        element.removeClass('active')
+      })
+
+      sideBar.child('.panel.' + target.className.replace(' item', '')).addClass('active')
+
+      target.addClass('active')
+    })
+
+    list.appendChild(tab)
+    active = ''
+  })
+
+  if (list.childNodes.length > 1) {
+    sideBarInner.insertBefore(list, sideBarInner.childNodes[0])
+    sideBar.child('.panels').style.paddingTop = ''
+  } else {
+    sideBar.child('.panels').style.paddingTop = '.625rem'
+  }
+}
+
+export const sidebarTOC = () => {
+  const activateNavByIndex = (index:number): void => {
+    const target = navItems[index]
+
+    if (!target) return
+
+    if (target.hasClass('current')) {
+      return
+    }
+
+    $dom.each('.toc .active', (element) => {
+      element && element.removeClass('active current')
+    })
+
+    sections.forEach((element) => {
+      element && element.removeClass('active')
+    })
+
+    target.addClass('active current')
+    sections[index] && sections[index].addClass('active')
+
+    let parent = <Element> target.parentNode
+
+    while (!parent.matches('.contents')) {
+      if (parent.matches('li')) {
+        parent.addClass('active')
+        const t = $dom(parent.child('a.toc-link').getAttribute('href'))
+        if (t) {
+          t.addClass('active')
+        }
+      }
+      parent = <Element> parent.parentNode
+    }
+    // Scrolling to center active TOC element if TOC content is taller than viewport.
+    if (getComputedStyle(sideBar).display !== 'none' && tocElement.hasClass('active')) {
+      pageScroll(tocElement, target.offsetTop - (tocElement.offsetHeight / 4))
+    }
+  }
+  const navItems = $dom.all('.contents li')
+
+  if (navItems.length < 1) {
+    return
+  }
+
+  let sections = [...navItems]
+  let activeLock = null
+
+  sections = sections.map((element, index) => {
+    const link = element.child('a.toc-link')
+    const anchor = $dom(decodeURI(link.getAttribute('href')))
+    if (!anchor) return null
+    const alink = anchor.child('a.anchor')
+
+    const anchorScroll = (event:MouseEvent) => {
+      event.preventDefault()
+      const target = $dom(decodeURI((event.currentTarget as HTMLElement).getAttribute('href')))
+
+      activeLock = index
+      pageScroll(target, null, () => {
+        activateNavByIndex(index)
+        activeLock = null
+      })
+    }
+
+    // TOC item animation navigate.
+    link.addEventListener('click', anchorScroll)
+    alink && alink.addEventListener('click', (event) => {
+      anchorScroll(event)
+      clipBoard(CONFIG.hostname + '/' + LOCAL.path + (event.currentTarget as HTMLElement).getAttribute('href'))
+    })
+    return anchor
+  })
+
+  const tocElement = sideBar.child('.contents.panel')
+
+  const findIndex = (entries: IntersectionObserverEntry[]) => {
+    let index = 0
+    let entry = entries[index]
+
+    if (entry.boundingClientRect.top > 0) {
+      index = sections.indexOf(entry.target as HTMLElement)
+      return index === 0 ? 0 : index - 1
+    }
+    for (; index < entries.length; index++) {
+      if (entries[index].boundingClientRect.top <= 0) {
+        entry = entries[index]
+      } else {
+        return sections.indexOf(entry.target as HTMLElement)
+      }
+    }
+    return sections.indexOf(entry.target as HTMLElement)
+  }
+
+  const createIntersectionObserver = () => {
+    const observer = new IntersectionObserver((entries) => {
+      const index = findIndex(entries) + (diffY < 0 ? 1 : 0)
+      if (activeLock === null) {
+        activateNavByIndex(index)
+      }
+    }, {
+      rootMargin: '0px 0px -100% 0px', threshold: 0
+    })
+
+    sections.forEach((element) => {
+      element && observer.observe(element)
+    })
+  }
+
+  createIntersectionObserver()
+}
+
+export const backToTopHandle = () => {
+  pageScroll(0)
+}
+
+export const goToBottomHandle = () => {
+  pageScroll(parseInt(String(Container.changeOrGetHeight())))
+}
+
+export const goToCommentHandle = () => {
+  pageScroll($dom('#comments'))
+}
+
+export const menuActive = () => {
+  $dom.each('.menu .item:not(.title)', (element) => {
+    const target = <HTMLAnchorElement> element.child('a[href]')
+    const parentItem = element.parentNode.parentNode
+    if (!target) return
+    const isSamePath = target.pathname === location.pathname || target.pathname === location.pathname.replace('index.html', '')
+    const isSubPath = !CONFIG.root.startsWith(target.pathname) && location.pathname.startsWith(target.pathname)
+    const active = target.hostname === location.hostname && (isSamePath || isSubPath)
+    element.toggleClass('active', active)
+    if (element.parentNode.child('.active') && parentItem.hasClass('dropdown')) {
+      parentItem.removeClass('active').addClass('expand')
+    } else {
+      parentItem.removeClass('expand')
+    }
+  })
+}