hexo-theme-shokax 0.0.1-alpha4 → 0.0.1-alpha6

package/LICENSE

@@ -1,21 +1,28 @@
-MIT License
+BSD 3-Clause License
 
-Copyright (c) 2022 zkz098
+Copyright (c) 2022, zkz098
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
 
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/README.md

@@ -4,8 +4,9 @@
 ![stars](https://img.shields.io/github/stars/zkz098/hexo-theme-shokaX)
 ![version](https://shields.io/npm/v/hexo-theme-shokax)
 
-此项目是shoka的一个魔改版,致力于提高性能和优化魔改体验 \
-本项目处于高强度开发期,但github仓库版本已基本可用 \s
+此项目是shoka的一个二次开发版(算精神续作),致力于提高性能和优化魔改体验 \
+诞生原因是目前shoka已经两年没有更新了,积压了大量BUG和功能请求。\
+本项目处于高强度开发期,但github仓库版本已基本可用 \
 二次开发与常见问题请看wiki
 
 ## 待办名单
@@ -16,20 +17,25 @@
 - [x] 注入js和css支持
 - [x] 自定义font
 - [x] 部分功能调整为可关闭
-- [ ] 重构lib方法(长期计划)
-- [ ] 异步化js
-
-## 已于从shoka迁移吗?
-很容易,只需要调整shoka的部分配置,并重新安装渲染器就行
-
-## 以前的魔改呢?
-这个比较难解决,因为shokaX对编写语言进行了更改:
-- javascript -> typescript
-- njk -> pug
-  因此需要更改编写的语言
+- [ ] 插件系统
+
+## 和shoka的区别
+原先shoka使用了javascript+Native+nunjucks的技术 \
+而shokaX则使用了typescript+Vue 3+Pug的技术搭配 \
+图标库可能会更换为Font Awesome 6 \
+更改了大量难以访问的CDN链接
+
+## 如何安装?
+建议使用[ShokaX-CLI](https://github.com/zkz098/shokaX-CLI) ,执行下列命令即可:
+```bash
+npm i shokax-cli --location=global
+# hexo init 初始化环境
+SXC install shokaX
+```
 
 # 许可证
-许可证: MIT \
+许可证: BSD-3-Clause \
+请注意: `0.0.1-alpha6`版本开始,shokaX使用BSD协议,这意味着删除页脚处的shokaX标识是违反许可证的
 [![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fzkz098%2Fhexo-theme-shokaX.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fzkz098%2Fhexo-theme-shokaX?ref=badge_large)
 
 # 致谢名单

package/layout/archive.pug

@@ -29,3 +29,90 @@ block content
                 != `${page.month}${__('symbol.month')}`
                 small
                     != __('title.archive')
+            else if is_year()
+                a(href=url_for(config.archive_dir))
+                    != __('title.all')
+                small /
+                != page.year + __('symbol.year')
+                small
+                    != __('title.archive')
+            else
+                a(href=url_for(site.path))
+                    != __('menu.home')
+                small /
+                - var posts_length = site.posts.length,cheers
+                if posts_length > 210
+                    - cheers = 'excellent'
+                else if posts_length > 130
+                    - cheers = 'great'
+                else if posts_length > 80
+                    - cheers = 'good'
+                else if posts_length > 50
+                    - cheers = 'nice'
+                else if posts_length > 30
+                    - cheers = 'ok'
+                else
+                    - cheers = 'um'
+                != _p('counter.archive_posts', site.posts.length)
+                small(class="cheers")
+                    != __('cheers.' + cheers)
+                    != ' '
+                    != __('keep_on')
+
+        - var current_year = '1970'
+        - var current_month = '01'
+        - var count_post = 1
+        each post in page.posts.toArray()
+            - var year = date(post.date, 'YYYY')
+            - var month = date(post.date, 'MM')
+            if !is_year()
+                if year !== current_year || month !== current_month
+                    if current_year !== '1970'
+                        small (#{count_post})
+                        </h3>
+                    <h3 class="item section">
+                    a(href=url_for(config.archive_dir + '/' + year )) #{year} #{__('symbol.year')}
+                    small /
+                    a(href=url_for(config.archive_dir + '/' + year  + '/' + month)) #{ month } #{__('symbol.month')}
+                    - current_year = year
+                    - current_month = month
+                    - count_post = 1
+                else
+                    - count_post = count_post + 1
+            else
+                if year !== current_year && !is_year()
+                    - current_year = year
+                    h3(class="item section")
+                        a(href=url_for(config.archive_dir + '/' + year )) #{ year } #{__('symbol.year')}
+                if month !== current_month && is_year() && !is_month()
+                    - current_month = month
+                    h3(class="item section")
+                        a(href=url_for(config.archive_dir + '/' + year + '/' + month)) #{ month } #{__('symbol.month')}
+                article(class="item normal" itemscope itemtype="http://schema.org/Article")
+                    div(class="meta")
+                        time(
+                            itemprop="dateCreated"
+                            datetime=moment(post.date).format()
+                            content=date(post.date, config.date_format)
+                        ) #{date(post.date, 'MM-DD')}
+                        if post.categories && post.categories.length
+                            - var cat_length = post.categories.length
+                            each cat,index in post.categories.toArray()
+                                if index == cat_length && cat.name !== page.category
+                                    span
+                                        a(href=url_for(cat.path)) #{cat.name}
+                    div(class="title")
+                        if post.link
+                            - var postTitleIcon = '<i class="ic i-link-alt"></i>'
+                            - var postText = post.title || post.link
+                            != _url(post.link, postText + postTitleIcon, {class: 'external', itemprop: 'url'})
+                        else
+                            - var postTitle = post.title || __('post.untitled')
+                            a(href=url_for(post.path) itemprop="url")
+                                span(itemprop="name") #{postTitle}
+        if !is_year()
+            small (#{count_post})
+            </h3>
+
+    include _partials/pagination.pug
+

package/layout/category.pug

@@ -11,15 +11,13 @@ block content
     div(class="collapse wrap")
         - var prev = _category_prev(page.category)
         h2(class="item header")
-            a(href=url_for(config.category_dir))
-                != __('title.all')
+            a(href=url_for(config.category_dir)) #{__('title.all')}
             if prev
                 small /
                 != prev
             small /
             != page.title
-            small
-                != __('title.category')
+            small #{__('title.category')}
         - var posts = page.posts
         - var current = "c"
         - var lastcat = ""
@@ -40,7 +38,7 @@ block content
                                 if index >= post.categories.toArray().length
                                     != cat.length
                                 else
-                                    != "/"
+                                    #{'/'}
                     - var lastcatslug = lastcatslug + cat.slug
             if lastcat && lastcatslug && lastcatslug !== current
                 h3(class="item section")
@@ -52,8 +50,7 @@ block content
                     itemprop="dateCreated"
                     datetime=moment(post.date).format()
                     content=date(post.date, config.date_format)
-                    )
-                        != date(post.date, 'MM-DD')
+                    ) #{date(post.date, 'MM-DD')}
                 div(class="title")
                     if post.link
                         - var postTitleIcon = '<i class="ic i-link-alt"></i>'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hexo-theme-shokax",
-  "version": "0.0.1-alpha4",
+  "version": "0.0.1-alpha6",
   "description": "a hexo theme based on shoka",
   "main": "index.js",
   "repository": "https://github.com/zkz098/hexo-theme-shokaX",

package/scripts/generaters/config.js

@@ -35,7 +35,7 @@ hexo.extend.filter.register('before_generate', () => {
     }
   }
 
-  if (data.images && data.images.length > 6) {
+  if (data.images && data.images.length >= 6) {
     hexo.theme.config.image_list = data.images
   } else {
     hexo.theme.config.image_list = yaml.load(fs.readFileSync(path.join(__dirname, '../../_images.yml')))

package/scripts/generaters/script.js

@@ -61,10 +61,18 @@ hexo.extend.generator.register('script', function (locals) {
   let text = '';
 
   ['library', 'global', 'page', 'vue', 'components'].forEach(function (item) {
-    text += fs.readFileSync(`themes/shokaX/source/js/_app/${item}.js`).toString()
+    if (fs.existsSync(`themes/shokaX/source/js/_app/${item}.js`)) {
+      text += fs.readFileSync(`themes/shokaX/source/js/_app/${item}.js`).toString()
+    } else {
+      text += fs.readFileSync(`node_modules/hexo-theme-shokax/source/js/_app/${item}.js`).toString()
+    }
   })
   if (!theme.experiments?.noPlayer) {
-    text += fs.readFileSync('themes/shokaX/source/js/_app/player.js').toString()
+    if (fs.existsSync('themes/shokaX/source/js/_app/player.js')) {
+      text += fs.readFileSync('themes/shokaX/source/js/_app/player.js').toString()
+    } else {
+      text += fs.readFileSync('node_modules/hexo-theme-shokax/source/js/_app/player.js').toString()
+    }
   }
   if (theme.fireworks && theme.fireworks.enable) {
     siteConfig.fireworks = theme.fireworks.color || ['rgba(255,182,185,.9)', 'rgba(250,227,217,.9)', 'rgba(187,222,214,.9)', 'rgba(138,198,209,.9)']

package/scripts/plugin/index.js

@@ -1,58 +1,6 @@
 /* global hexo */
-'use strict'
 
-/** @type {Map<string, string[]>} */
-const insertions = new Map()
-class TemplateBlock {
-  constructor (text, type = 'raw') {
-    this.text = text
-    this.type = type
-    this.result = ''
-  }
-
-  render () {
-    if (this.type === 'raw' || this.type === 'html') {
-      this.result = this.text
-    }
-    this.result = hexo.render.renderSync({ text: this.text, engine: this.type })
-  }
-
-  repalceTag (...tag) {
-    tag.forEach((item) => {
-      this.text = this.text.replace(item.tag, item.value)
-    })
-  }
-
-  insert (location) {
-    if (insertions.get(location)) {
-      insertions.get(location).push(this.result)
-    } else {
-      insertions.set(location, [])
-    }
-  }
-}
-
-const toolpack = {
-  TemplateBlock
-}
-
-hexo.extend.helper.register('insert_footer', () => {
-  if (hexo.theme.config?.plugin?.enable && insertions.get('footer')) {
-    let res = ''
-    insertions.get('footer').forEach((item) => {
-      res += item
-    })
-    return res
-  }
-})
-
-if (hexo.theme.config?.plugin?.enable) {
-  hexo.theme.config.plugin.load.forEach((item) => {
-    const p = require(item)
-    console.log(p)
-    if (p.prepare) {
-      p.prepare(hexo, this)
-    }
-    p.main(hexo, this, toolpack)
-  })
-}
+// hexo.on('generateBefore', () => {
+//   // 加载`theme_injects`过滤器
+//   require('./lib/injects')(hexo);
+// });

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

@@ -0,0 +1,20 @@
+'use strict'
+
+module.exports = {
+  views: [
+    'head',
+    'header',
+    'sidebar',
+    'rightNav',
+    'postMeta',
+    'postBodyEnd',
+    'footer',
+    'bodyEnd',
+    'comment'
+  ],
+  styles: [
+    'variable',
+    'mixin',
+    'style'
+  ]
+}

package/scripts/plugin/lib/injects.js

@@ -0,0 +1,88 @@
+'use strict'
+
+const fs = require('fs')
+const path = require('path')
+const points = require('./injects-point')
+const defaultExtname = '.pug'
+
+// Defining stylus types
+class StylusInject {
+  constructor (base_dir) {
+    this.base_dir = base_dir
+    this.files = []
+  }
+
+  push (file) {
+    // Get absolute path base on hexo dir
+    this.files.push(path.resolve(this.base_dir, file))
+  }
+}
+
+// Defining view types
+class ViewInject {
+  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
+}
+
+module.exports = (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, y) => x.order - y.order)
+  })
+}