hexo-renderer-markdown-exit 0.0.1 → 1.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "hexo-renderer-markdown-exit",
-  "version": "0.0.1",
+  "version": "1.0.0",
   "description": "A Hexo renderer plugin using markdown-exit",
   "main": "dist/index.js",
   "keywords": [
@@ -9,11 +9,16 @@
     "markdown",
     "markdown-exit"
   ],
+  "scripts": {
+    "build": "vite build",
+    "fmt": "bunx biome check --write ."
+  },
   "author": "GnixAIj",
   "license": "MIT",
   "dependencies": {
     "@mdit/plugin-tab": "^0.23.0",
     "markdown-exit": "^1.0.0-beta.6",
+    "markdown-exit-shiki": "^0.1.0",
     "markdown-it-abbr": "^2.0.0",
     "markdown-it-anchor": "^9.2.0",
     "markdown-it-emoji": "^3.0.0",
@@ -32,6 +37,7 @@
     "bun-types": "^1.1.18",
     "hexo": "^7.0.0",
     "hexo-util": "^4.0.0",
-    "typescript": "^5.0.0"
+    "typescript": "^5.0.0",
+    "vite": "^7.2.7"
   }
 }

package/readme.md

@@ -37,4 +37,5 @@ just check
 
 ## Know Issues
 
-- [] `abbr` plugin not working
+- [ ] `abbr` plugin not working
+- [ ] hexo custom tags not working

package/src/index.ts

@@ -1,10 +1,19 @@
 import type { StoreFunction, StoreFunctionData } from "hexo/dist/extend/renderer";
 import { MarkdownRenderer } from "./renderer";
 
-const rendererInstance = new MarkdownRenderer(hexo);
+let rendererInstance: MarkdownRenderer | null = null;
 
+function getRenderer(): MarkdownRenderer {
+	if (!rendererInstance) {
+		rendererInstance = new MarkdownRenderer(hexo);
+	}
+	return rendererInstance;
+}
+
+// Hexo在执行`clean`命令删除`public`目录时也会加载各个插件，包括本插件中渲染器的注册
+// 所以把渲染器的实例化延迟到真正需要渲染时再进行，避免在`clean`命令时进行不必要的初始化操作
 const render: StoreFunction = async (data: StoreFunctionData): Promise<string> =>
-	await rendererInstance.render(data);
+	await getRenderer().render(data);
 
 render.disableNunjucks = Boolean(hexo.config.markdown_exit.disableNunjucks);
 

package/src/renderer.ts

@@ -3,6 +3,7 @@ import { tab } from "@mdit/plugin-tab";
 import type Hexo from "hexo";
 import type { StoreFunctionData } from "hexo/dist/extend/renderer";
 import { createMarkdownExit, type MarkdownExit } from "markdown-exit";
+import code from "markdown-exit-shiki";
 import abbr from "markdown-it-abbr";
 import anchor from "markdown-it-anchor";
 import { full as emoji } from "markdown-it-emoji";
@@ -13,6 +14,7 @@ import mathjax3Pro from "markdown-it-mathjax3-pro";
 import sub from "markdown-it-sub";
 import sup from "markdown-it-sup";
 import taskLists from "markdown-it-task-lists";
+
 import type { MarkdownExitConfig, PluginConfig } from "../types/types";
 
 export class MarkdownRenderer {
@@ -32,6 +34,11 @@ export class MarkdownRenderer {
 				typographer: true,
 				xhtmlOut: false,
 			},
+			code_options: {
+				themes: {
+					light: "catppuccin-latte",
+				},
+			},
 			...hexo.config.markdown_exit,
 		};
 
@@ -40,6 +47,7 @@ export class MarkdownRenderer {
 	}
 
 	private initPlugins() {
+		console.time("MarkdownExit: Load Default Plugins");
 		if (this.config.defaultPlugins !== false) {
 			this.md
 				// @ts-expect-error: MarkdownExit is compatible with MarkdownIt at runtime but types mismatch
@@ -51,6 +59,7 @@ export class MarkdownRenderer {
 				.use(abbr)
 				.use(ins)
 				.use(taskLists)
+				.use(code, this.config.code_options)
 				// @ts-expect-error: MarkdownExit is compatible with MarkdownIt at runtime but types mismatch
 				.use(tab)
 				// @ts-expect-error: MarkdownExit is compatible with MarkdownIt at runtime but types mismatch
@@ -58,46 +67,31 @@ export class MarkdownRenderer {
 				// @ts-expect-error: MarkdownExit is compatible with MarkdownIt at runtime but types mismatch
 				.use(mathjax3Pro);
 		}
-
+		console.timeEnd("MarkdownExit: Load Default Plugins");
+		console.time("MarkdownExit: Load User Plugins");
 		this.loadUserPlugins();
+		console.timeEnd("MarkdownExit: Load User Plugins");
 	}
 
 	private loadUserPlugins() {
 		const plugins: PluginConfig[] = this.config.plugins || [];
-		const baseDir = this.hexo.base_dir;
-
-		if (!Array.isArray(plugins)) {
-			console.warn("Plugins configuration is not an array. Skipping plugin loading.");
-			return;
-		}
-
-		const userNodeModules = path.join(baseDir, "node_modules");
-
 		for (const pluginConfig of plugins) {
-			let pluginName: string | undefined;
-			let pluginOptions = {};
+			const isString = typeof pluginConfig === "string";
+			const pluginName = isString ? pluginConfig : pluginConfig.name;
+			const pluginOptions = isString ? {} : pluginConfig.options || {};
 
-			if (typeof pluginConfig === "string") {
-				pluginName = pluginConfig;
-			} else if (typeof pluginConfig === "object" && pluginConfig.name) {
-				pluginName = pluginConfig.name;
-				pluginOptions = pluginConfig.options || {};
-			}
-
-			if (pluginName) {
-				try {
-					const pluginPath = path.join(userNodeModules, pluginName);
-					const plugin = require(pluginPath);
-					const pluginFn = plugin.default || plugin;
-					this.md.use(pluginFn, pluginOptions);
-          if (process.env.DEBUG) {
-            console.log(`✅ Successfully loaded plugin: ${pluginName}`);
-          }
-				} catch (e) {
-					console.warn(`⚠️  Failed to load plugin: ${pluginName}`);
-					if (process.env.DEBUG) {
-						console.warn(`   Error: ${e}`);
-					}
+			try {
+				const pluginPath = path.join(this.hexo.base_dir, "node_modules", pluginName);
+				const plugin = require(pluginPath);
+				const pluginFn = plugin.default || plugin;
+				this.md.use(pluginFn, pluginOptions);
+				if (process.env.DEBUG) {
+					console.log(`✅ Successfully loaded plugin: ${pluginName}`);
+				}
+			} catch (e) {
+				console.warn(`⚠️  Failed to load plugin: ${pluginName}`);
+				if (process.env.DEBUG) {
+					console.warn(`   Error: ${e}`);
 				}
 			}
 		}

package/types/types.d.ts

@@ -6,6 +6,7 @@ interface MarkdownExitConfig {
 	defaultPlugins?: boolean;
 	plugins?: PluginConfig[];
 	render_options?: MarkdownExitOptions;
+	code_options?: InlineCodeOptions;
 	anchor_options?: AnchorOptions;
 	disableNunjucks?: boolean;
 }

package/vite.config.ts

@@ -0,0 +1,20 @@
+import { defineConfig } from "vite";
+import pkg from "./package.json";
+
+export default defineConfig({
+  build: {
+    lib: {
+      entry: "./src/index.ts",
+      name: "hexo-renderer-markdown-exit",
+      formats: ["cjs"],
+      fileName: () => "index.js",
+    },
+    rollupOptions: {
+      external: [
+        ...Object.keys(pkg.dependencies || {}),
+        /^node:/,
+        "hexo",
+      ],
+    },
+  },
+});

package/dist/renderer.js

@@ -1,94 +0,0 @@
-
-var __importDefault = (this && this.__importDefault) || ((mod) => (mod && mod.__esModule) ? mod : { "default": mod });
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.renderer = void 0;
-const markdown_exit_1 = require("markdown-exit");
-const markdown_it_emoji_1 = require("markdown-it-emoji");
-const markdown_it_footnote_1 = __importDefault(require("markdown-it-footnote"));
-const markdown_it_mark_1 = __importDefault(require("markdown-it-mark"));
-const markdown_it_mathjax3_pro_1 = __importDefault(require("markdown-it-mathjax3-pro"));
-const markdown_it_sub_1 = __importDefault(require("markdown-it-sub"));
-const markdown_it_sup_1 = __importDefault(require("markdown-it-sup"));
-const markdown_it_task_lists_1 = __importDefault(require("markdown-it-task-lists"));
-const markdown_it_abbr_1 = __importDefault(require("markdown-it-abbr"));
-const markdown_it_ins_1 = __importDefault(require("markdown-it-ins"));
-let cachedMd;
-let cachedConfig;
-// Hexo 7.x
-const renderer = async function (data, options) {
-    if (!data.text) {
-        return '';
-    }
-    const hexoConfig = this.config;
-    const config = { ...hexoConfig.markdown_exit, ...options };
-    const configStr = JSON.stringify(config);
-    if (cachedMd && cachedConfig === configStr) {
-        return cachedMd.renderAsync(data.text);
-    }
-    const markdownExitConfig = {
-        breaks: true,
-        html: true,
-        langPrefix: "language-",
-        linkify: true,
-        quotes: "“”‘’",
-        typographer: true,
-        xhtmlOut: false,
-        ...hexoConfig.markdown_exit?.render_options
-    };
-    const md = (0, markdown_exit_1.createMarkdownExit)(markdownExitConfig);
-    if (config.defaultPlugins !== false) {
-        md.use(markdown_it_emoji_1.full)
-            .use(markdown_it_footnote_1.default)
-            .use(markdown_it_mark_1.default)
-            .use(markdown_it_sub_1.default)
-            .use(markdown_it_sup_1.default)
-            .use(markdown_it_abbr_1.default)
-            .use(markdown_it_ins_1.default)
-            .use(markdown_it_task_lists_1.default)
-            .use(markdown_it_mathjax3_pro_1.default);
-    }
-    // Register plugins from the user's configuration
-    loadMarkdownItPlugins(md, config.plugins || [], this.base_dir);
-    cachedMd = md;
-    cachedConfig = configStr;
-    return md.renderAsync(data.text);
-};
-exports.renderer = renderer;
-function loadMarkdownItPlugins(md, plugins, baseDir) {
-    // 确保 plugins 是一个数组
-    if (!Array.isArray(plugins)) {
-        console.warn('Plugins configuration is not an array. Skipping plugin loading.');
-        return;
-    }
-    // 遍历插件配置
-    for (const pluginConfig of plugins) {
-        let pluginName;
-        let pluginOptions = {};
-        if (typeof pluginConfig === 'string') {
-            pluginName = pluginConfig;
-        }
-        else if (typeof pluginConfig === 'object' && pluginConfig.name) {
-            pluginName = pluginConfig.name;
-            pluginOptions = pluginConfig.options || {};
-        }
-        if (pluginName) {
-            try {
-                let plugin;
-                try {
-                    const pluginPath = require.resolve(pluginName, { paths: [baseDir] });
-                    plugin = require(pluginPath);
-                }
-                catch (e) {
-                    plugin = require(pluginName);
-                }
-                const pluginFn = plugin.default || plugin;
-                md.use(pluginFn, pluginOptions);
-                console.log(`✅ Successfully loaded plugin: ${pluginName}`);
-            }
-            catch (e) {
-                console.warn(`⚠️  Failed to load plugin: ${pluginName}`);
-                console.warn(`   Please install it in your Hexo project: npm install ${pluginName}`);
-            }
-        }
-    }
-}

package/dist/types.js

@@ -1 +0,0 @@
-

package/justfile

@@ -1,4 +0,0 @@
-build:
-    bun build src/index.ts --outdir dist
-check:
-    bunx biome check --write .