hexo-theme-gnix 1.1.0

package/README.md

@@ -0,0 +1,106 @@
+# Hexo Theme Icarus
+
+## Demo & Preview
+
+[vluv's space](https://vluv.space/)
+
+### Multiple Theme Support
+
+Support multiple light and dark themes:
+
+- **System Theme**: Follow system theme automatically, use `Nord` for light mode and `Mocha` for dark mode by default
+- **Light Themes**: `Nord`, `Cattpuccin Latte`
+- **Dark Themes**: `Catppuccin Mocha`, `Catppuccin Macchiato`, `Tokyo Night`
+
+| ![](assets/README/nord.png) | ![](assets/README/mocha.png) |
+| --------------------------- | ---------------------------- |
+
+### Mermaid Filter [^2]
+
+[^2]:
+    Require [Efterklang/hexo-mermaid-diagram](https://github.com/Efterklang/hexo-mermaid-diagram)
+    🚧 Dark mode WIP...
+
+![image](https://github.com/user-attachments/assets/3bd2d897-721d-4505-8194-6a592bbceb31)
+
+### Components
+
+#### Table
+
+| ![1763371106238](assets/README/table_nord.png) | ![1763371131768](assets/README/table_tokyo.png) |
+| ---------------------------------------------- | ----------------------------------------------- |
+
+#### Quote
+
+| ![1763371059037](assets/README/quote_light.png) |
+| ----------------------------------------------- |
+| ![1763371021736](assets/README/quote_dark.png)  |
+
+#### Footer
+
+| ![1763371250167](assets/README/footer_nord.png) |
+| ----------------------------------------------- |
+| ![1763371215054](assets/README/footer_dark.png) |
+
+## Installation
+
+### Using git submodule(Recommended)
+
+Using git submodule instead of bun add is recommended if you want to make any customizations to the theme
+
+```shell
+$ git submodule add https://github.com/Efterklang/hexo-theme-icarus themes/icarus
+$ hexo config theme icarus
+```
+
+```diff package.json
+{
+  "dependencies": {
++   "hexo": "^7.2.0",
++   "hexo-cli": "^4.3.2",
++   "hexo-generator-archive": "^2.0.0",
++   "hexo-generator-category": "^2.0.0",
++   "hexo-generator-tag": "^2.0.0",
++   "hexo-pagination": "^3.0.0",
++   "hexo-renderer-inferno": "^1.0.2",
++   "hexo-server": "^3.0.0",
++   "hexo-util": "^3.3.0",
++   "inferno": "^9.0.3",
++   "inferno-create-element": "^9.0.3",
++   "moment": "^2.30.1"
+  }
+}
+```
+
+### Using Bun
+
+```shell
+$ bun add git+https://github.com/Efterklang/hexo-theme-icarus
+$ hexo config theme icarus
+```
+
+## Setup
+
+<details>
+<summary>Math Rendering Setup</summary>
+
+To enable math rendering with optimized performance, use [markdown-it-mathjax3-pro](https://github.com/NeoNexusX/markdown-it-mathjax3-pro), which supports both SSR and CSR modes
+
+</details>
+
+<details>
+<summary>Code Highlight Setup</summary>
+
+Use [hexo-shiki-highlight](https://github.com/Efterklang/hexo-shiki-highlight) plugin for code block highlighting, support multiple themes as well;
+
+Set `syntax_highlighter` to `shiki` in your hexo `_config.yml`:
+
+```yaml _config.yml
+# Syntax Highlighter
+syntax_highlighter: shiki
+```
+
+| <img width="1386" height="720" alt="image" src="https://github.com/user-attachments/assets/f0435c12-5140-4ca4-86bb-e5237039cc2d" /> | <img width="1394" height="736" alt="image" src="https://github.com/user-attachments/assets/406a656f-9e99-4fb7-bb34-a2e1078451e4" /> |
+| ----------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- |
+
+</details>

package/include/hexo/filter/locals.js

@@ -0,0 +1,109 @@
+/**
+ * Register the Hexo filter for merging theme and site config, and add all helper functions to a
+ * dedicated property (<code>helper</code>) in the locals.
+ * @module hexo/filter/locals
+ */
+const fs = require("node:fs");
+const path = require("node:path");
+const yaml = require("js-yaml");
+
+/**
+ * Register the Hexo filter for merging theme and site config, and add all helper functions to a
+ * dedicated property (<code>helper</code>) in the locals.
+ * <p>
+ * This filter will try to merge
+ * <ul>
+ * <li>the post/page config defined in the Markdown file's front-matter,</li>
+ * <li>post/page config defined in <code>themes/[theme_name]/_config.post.yml</code> or
+ * <code>themes/[theme_name]/_config.page.yml</code>,</li>
+ * <li>post/page layout config defined in <code>[site_root]/_config.post.yml</code> or
+ * <code>[site_root]/_config.page.yml</code>,</li>
+ * <li>theme config defined in <code>themes/[theme_name]/_config.yml</code> or
+ * <code>node_modules/hexo-theme-[theme_name]/_config.yml</code> if it is installed as an NPM package,
+ * </li>
+ * <li>and the site config defined in <code>_config.yml</code>,</li>
+ * </ul>
+ * in the above order (the former config will overwrite later ones).
+ * This allow the user to customize the theme for each post/page, as well as for all post or pages.
+ * <br>
+ * It also adds a new variable named <code>helper</code>, containing all Hexo helper functions, to the page
+ * locals so that you can them through it instead.
+ * It is useful for passing helper functions to the cacheable view components.
+ * <p>
+ * <b>NOTE: This filter must be registered before any other Hexo extensions or views in order to take effect.</b>
+ *
+ * @param {Hexo} hexo The Hexo instance.
+ */
+module.exports = (hexo) => {
+  const RESERVED_KEYS = {
+    post: Object.keys(require("hexo/dist/models/post")(hexo).paths),
+    page: Object.keys(require("hexo/dist/models/page")(hexo).paths),
+  };
+
+  function loadLayoutConfig(layout) {
+    let config = {};
+    const configInSiteDir = path.join(hexo.base_dir, `_config.${layout}.yml`);
+    const configInThemeDir = path.join(hexo.theme_dir, `_config.${layout}.yml`);
+    [configInSiteDir, configInThemeDir].forEach((configPath) => {
+      if (fs.existsSync(configPath)) {
+        config = Object.assign(config, yaml.load(fs.readFileSync(configPath)));
+      }
+    });
+    return config;
+  }
+
+  const ALTERNATIVE_CONFIG = {
+    post: loadLayoutConfig("post"),
+    page: loadLayoutConfig("page"),
+  };
+
+  function stripConfig(source, reservedKeys) {
+    const result = {};
+    Object.keys(source)
+      .filter(
+        (key) =>
+          !key.startsWith("_") &&
+          !reservedKeys.includes(key) &&
+          typeof source[key] !== "function",
+      )
+      .forEach((key) => {
+        result[key] = source[key];
+      });
+    return result;
+  }
+
+  hexo.extend.filter.register("template_locals", (locals) => {
+    // inject helper functions
+    locals.helper = {};
+    const helpers = hexo.extend.helper.list();
+    for (const name in helpers) {
+      locals.helper[name] = helpers[name].bind(locals);
+    }
+    if (typeof locals.__ === "function") {
+      locals.helper.__ = locals.__;
+    }
+    if (typeof locals._p === "function") {
+      locals.helper._p = locals._p;
+    }
+
+    const page = locals.page;
+    if (page) {
+      locals.config = Object.assign({}, locals.config, locals.theme);
+      if (page.layout in ALTERNATIVE_CONFIG) {
+        // load alternative config if exists
+        locals.config = Object.assign(
+          locals.config,
+          ALTERNATIVE_CONFIG[page.layout],
+        );
+      }
+      // merge page configs
+      if (page.__post === true) {
+        Object.assign(locals.config, stripConfig(page, RESERVED_KEYS.post));
+      } else if (page.__page === true) {
+        Object.assign(locals.config, stripConfig(page, RESERVED_KEYS.page));
+      }
+    }
+
+    return locals;
+  });
+};

package/include/hexo/generator/categories.js

@@ -0,0 +1,12 @@
+// Generates the <root>/categories page
+module.exports = (hexo) => {
+  hexo.extend.generator.register("categories", (locals) => {
+    return {
+      path: "categories/",
+      layout: ["categories"],
+      data: Object.assign({}, locals, {
+        __categories: true,
+      }),
+    };
+  });
+};

package/include/hexo/generator/category.js

@@ -0,0 +1,52 @@
+/**
+ * Register the Hexo generator for generating <code>/category/</code> pages.
+ * @module hexo/generator/category
+ */
+const pagination = require("hexo-pagination");
+
+/**
+ * Register the Hexo generator for generating <code>/category/</code> pages.
+ * <p>
+ * An array of parent categories will be attached to the page local
+ * variables.
+ *
+ * @param {Hexo} hexo The Hexo instance.
+ */
+module.exports = (hexo) => {
+  hexo.extend.generator.register("category", function (locals) {
+    const config = this.config;
+    const paginationDir = config.pagination_dir || "page";
+    const perPage =
+      (config.category_generator ? config.category_generator.per_page : null) ||
+      0;
+    const orderBy =
+      (config.category_generator ? config.category_generator.order_by : null) ||
+      "-date";
+
+    function findParent(category) {
+      let parents = [];
+      if (typeof category === "object" && "parent" in category) {
+        const parent = locals.categories
+          .filter((cat) => cat._id === category.parent)
+          .first();
+        parents = findParent(parent).concat([parent]);
+      }
+      return parents;
+    }
+
+    return locals.categories.reduce((result, category) => {
+      const posts = category.posts.sort(orderBy);
+      const data = pagination(category.path, posts, {
+        perPage: perPage,
+        layout: ["category", "archive", "index"],
+        format: `${paginationDir}/%d/`,
+        data: {
+          category: category.name,
+          parents: findParent(category),
+        },
+      });
+
+      return result.concat(data);
+    }, []);
+  });
+};

package/include/hexo/generator/insight.js

@@ -0,0 +1,50 @@
+const util = require("hexo-util");
+
+module.exports = (hexo) => {
+  hexo.extend.generator.register("insight", function (locals) {
+    const url_for = hexo.extend.helper.get("url_for").bind(this);
+    function minify(str) {
+      return util
+        .stripHTML(str)
+        .trim()
+        .replace(/\n/g, " ")
+        .replace(/\s+/g, " ")
+        .replace(/&#x([\da-fA-F]+);/g, (_, hex) => {
+          return String.fromCharCode(parseInt(hex, 16));
+        })
+        .replace(/&#([\d]+);/g, (_, dec) => {
+          return String.fromCharCode(dec);
+        });
+    }
+    function mapPost(post) {
+      return {
+        title: util.escapeHTML(post.title).trim(),
+        text: minify(post.content),
+        link: url_for(post.path),
+      };
+    }
+    function mapTag(tag) {
+      return {
+        name: util.escapeHTML(tag.name).trim(),
+        slug: minify(tag.slug),
+        link: url_for(tag.path),
+      };
+    }
+    const site = {
+      posts: locals.posts.map(mapPost),
+      tags: locals.tags.map(mapTag),
+      categories: locals.categories.map(mapTag),
+    };
+    const index_pages = this.theme.config?.search?.index_pages;
+    if (index_pages === false) {
+      site.pages = [];
+    } else {
+      site.pages = locals.pages.map(mapPost);
+    }
+
+    return {
+      path: "/content.json",
+      data: JSON.stringify(site),
+    };
+  });
+};

package/include/hexo/generator/manifest.js

@@ -0,0 +1,23 @@
+/**
+ * Web app manifest.json generator.
+ */
+
+module.exports = (hexo) => {
+  hexo.extend.generator.register("manifest", function (_locals) {
+    const url_for = hexo.extend.helper.get("url_for").bind(this);
+    let { manifest = {} } = this.theme?.config?.head || {};
+
+    manifest = Object.assign({}, manifest);
+    if (!manifest.name) {
+      manifest.name = this.config.title;
+    }
+    if (!manifest.start_url) {
+      manifest.start_url = url_for("/index.html");
+    }
+
+    return {
+      path: "/manifest.json",
+      data: JSON.stringify(manifest),
+    };
+  });
+};

package/include/hexo/generator/tags.js

@@ -0,0 +1,12 @@
+// Generate "<root>/tags/" page
+module.exports = (hexo) => {
+  hexo.extend.generator.register("tags", (locals) => {
+    return {
+      path: "tags/",
+      layout: ["tags"],
+      data: Object.assign({}, locals, {
+        __tags: true,
+      }),
+    };
+  });
+};

package/include/hexo/helper/cdn.js

@@ -0,0 +1,21 @@
+function getCDN(cdn, pkg, version, filename) {
+  switch (cdn) {
+    case "host":
+      return `/js/host/${pkg}/${version}/${filename}`;
+    case "loli":
+      return `https://cdnjs.loli.net/ajax/libs/${pkg}/${version}/${filename}`;
+    case "jsdelivr":
+      return `https://cdn.jsdelivr.net/npm/${pkg}@${version}/${filename}`;
+    case "bootcdn":
+      return `https://cdn.bootcdn.net/ajax/libs/${pkg}/${version}/${filename}`;
+    default:
+      throw new Error(`Unknown CDN provider: ${cdn}`);
+  }
+}
+
+module.exports = (hexo) => {
+  hexo.extend.helper.register("cdn", function (_package, version, filename) {
+    cdn = this.config.providers?.cdn ? this.config.providers.cdn : "jsdelivr";
+    return getCDN(cdn, _package, version, filename);
+  });
+};

package/include/hexo/helper/page.js

@@ -0,0 +1,27 @@
+/**
+ * Register the Hexo helper functions for a Hexo page/post.
+ * @module hexo/helper/page
+ */
+
+/**
+ * Register the Hexo helper functions for a Hexo page/post.
+ *
+ * @param {Hexo} hexo The Hexo instance.
+ * @example
+ * // Use the function below to test if the given page is the /categories page
+ * // Need to be combined with lib/hexo/generator/categories
+ * is_categories(page);
+ *
+ * // Use the function below to test if the given page is the /tags page
+ * // Need to be combined with lib/hexo/generator/tags
+ * is_tags(page);
+ */
+module.exports = (hexo) => {
+  hexo.extend.helper.register("is_categories", function (page = null) {
+    return (page === null ? this.page : page).__categories === true;
+  });
+
+  hexo.extend.helper.register("is_tags", function (page = null) {
+    return (page === null ? this.page : page).__tags === true;
+  });
+};

package/include/hexo/view.js

@@ -0,0 +1,40 @@
+const path = require("node:path");
+
+let themeDir = null;
+
+function _resolve(filename) {
+  if (path.isAbsolute(filename)) {
+    return require.resolve(filename);
+  }
+  const resolved = [path.join(themeDir, "/layout/", filename)].find(
+    (filepath) => {
+      try {
+        require.resolve(filepath);
+        return true;
+      } catch (_e) {
+        return false;
+      }
+    },
+  );
+
+  return require.resolve(resolved ? resolved : filename);
+}
+
+function _require(filename) {
+  return require(_resolve(filename));
+}
+
+_require.resolve = _resolve;
+
+/**
+ * Initialize module global variables, including the theme directory variable.
+ * Must be used before {@link module:core/view.require} or {@link module:core/view.resolve}.
+ */
+function init(hexo) {
+  themeDir = hexo.theme_dir;
+}
+
+module.exports = {
+  init,
+  require: _require,
+};

package/include/register.js

@@ -0,0 +1,11 @@
+module.exports = (hexo) => {
+  require("./hexo/filter/locals")(hexo);
+  require("./hexo/generator/insight")(hexo);
+  require("./hexo/generator/categories")(hexo);
+  require("./hexo/generator/category")(hexo);
+  require("./hexo/generator/manifest")(hexo);
+  require("./hexo/generator/tags")(hexo);
+  require("./hexo/helper/cdn")(hexo);
+  require("./hexo/helper/page")(hexo);
+  require("./hexo/view").init(hexo);
+};

package/include/util/common.js

@@ -0,0 +1,33 @@
+/**
+ * 共享的工具函数和常量
+ */
+const { Component, Fragment } = require("inferno");
+const view = require("../hexo/view");
+const { cacheComponent } = require("../../util/cache");
+
+function lazy_load_css(href) {
+  script_str = `var link = document.createElement('link');
+  link.rel = 'stylesheet';
+  link.href = '${href}';
+  document.getElementsByTagName('head')[0].appendChild(link);`;
+  return script_str;
+}
+
+module.exports = {
+  // 导出常用的依赖
+  Component,
+  Fragment,
+  view,
+  lazy_load_css,
+  cacheComponent,
+
+  // 通用的组件加载函数
+  loadComponent: (componentPath, fallback = null) => {
+    try {
+      const Widget = view.require(componentPath);
+      return Widget.Cacheable ? Widget.Cacheable : Widget;
+    } catch (_) {
+      return fallback;
+    }
+  },
+};

package/languages/en.yml

@@ -0,0 +1,47 @@
+common:
+  archive:
+    one: "Archive"
+    other: "Archives"
+  category:
+    one: "Category"
+    other: "Categories"
+  tag:
+    one: "Tag"
+    other: "Tags"
+  post:
+    one: "Post"
+    other: "Posts"
+  page:
+    one: "Page"
+    other: "Pages"
+  prev: "Previous"
+  next: "Next"
+article:
+  created_at: "Posted %s"
+  more: "Read more"
+  comments: "Comments"
+  edited: "edited"
+  word_count:
+    one: "About %d word"
+    other: "About %d words"
+  licensing:
+    author: "Author"
+    created_at: "Posted on"
+    updated_at: "Updated on"
+    licensed_under: "Licensed under"
+plugin:
+  visit_count: "%s visits"
+  visitor_count: "Visited by %s users"
+  cookie_consent:
+    message: This website uses cookies to improve your experience.
+    dismiss: Got it!
+    allow: Allow cookies
+    deny: Decline
+    link: Learn more
+    policy: Cookie Policy
+search:
+  search: "Search"
+  hint: "Search(Ctrl/󰘳 + K)"
+  no_result: "No results for"
+  untitled: "(Untitled)"
+  empty_preview: "(No preview)"

package/languages/fr.yml

@@ -0,0 +1,46 @@
+common:
+  archive:
+    one: "Archive"
+    other: "Archives"
+  category:
+    one: "Catégorie"
+    other: "Catégories"
+  tag:
+    one: "Tag"
+    other: "Tags"
+  post:
+    one: "Article"
+    other: "Articles"
+  page:
+    one: "Page"
+    other: "Pages"
+  prev: "Préc"
+  next: "Suiv"
+article:
+  created_at: "Publié il y a %s"
+  more: "Lire la suite"
+  comments: "Commentaires"
+  word_count:
+    one: "Environ %d mot"
+    other: "Environ %d mots"
+  licensing:
+    author: "Auteur"
+    created_at: "Posté le"
+    updated_at: "Mis à jour le"
+    licensed_under: "Licencié sous"
+plugin:
+  visit_count: "%s visites"
+  visitor_count: "Visité par %s utilisateurs"
+  cookie_consent:
+    message: "Ce site Web utilise des cookies pour améliorer votre expérience."
+    dismiss: "C'est bon"
+    allow: "Autoriser les cookies"
+    deny: "Refuser"
+    link: "En savoir plus"
+    policy: "Politique relative aux cookies"
+search:
+  search: "Rechercher"
+  hint: "Ecrivez quelque chose..."
+  no_result: "Aucun résultat pour"
+  untitled: "(Sans titre)"
+  empty_preview: "(Pas de prévisualisation)"

package/languages/ja.yml

@@ -0,0 +1,46 @@
+common:
+  archive:
+    one: "アーカイブ"
+    other: "アーカイブ"
+  category:
+    one: "カテゴリ"
+    other: "カテゴリ"
+  tag:
+    one: "タグ"
+    other: "タグ"
+  post:
+    one: "投稿"
+    other: "投稿"
+  page:
+    one: "ページ"
+    other: "ページ"
+  prev: "前"
+  next: "次"
+article:
+  created_at: "%sに投稿"
+  more: "続きを読む"
+  comments: "コメント"
+  word_count:
+    one: "約%d語"
+    other: "約%d語"
+  licensing:
+    author: "Author"
+    created_at: "Posted on"
+    updated_at: "Updated on"
+    licensed_under: "Licensed under"
+plugin:
+  visit_count: "%s回の訪問"
+  visitor_count: "%s人のユーザーがアクセス"
+  cookie_consent:
+    message: このウェブサイトはあなたの経験を改善するためにCookieを使用しています。
+    dismiss: 了解しました
+    allow: Cookiesを許可する
+    deny: 拒否する
+    link: もっと詳しく知る
+    policy: Cookieポリシー
+search:
+  search: "検索"
+  hint: "何かを入力してください..."
+  no_result: "の結果はありません"
+  untitled: "(無題)"
+  empty_preview: "(プレビューなし)"