vue-markdown-design 0.3.0 → 0.3.2-beta

package/README.md

@@ -2,7 +2,29 @@ English | [中文](./README.zh-CN.md)
 
 # Vue Markdown Design
 
-A Vue 3 out-of-the-box Markdown component built on [markdown-it](https://github.com/markdown-it/markdown-it). It mainly features Markdown rendering, toc generation, and keyword search. It also includes other common functionalities such as support for markdown-it plugins, emoji, heading permalinks, XSS sanitization, and TypeScript.
+[![NPM Version](https://img.shields.io/npm/v/vue-markdown-design)](https://www.npmjs.com/package/vue-markdown-design) [![codecov](https://codecov.io/github/ZeroOneJs/markdown-design/graph/badge.svg?token=US6XWJTP8H)](https://codecov.io/github/ZeroOneJs/markdown-design) [![GitHub License](https://img.shields.io/github/license/ZeroOneJs/markdown-design)](https://github.com/ZeroOneJs/markdown-design/blob/main/packages/vue-markdown-design/LICENSE) [![Release](https://github.com/ZeroOneJs/markdown-design/actions/workflows/release.yml/badge.svg)](https://github.com/ZeroOneJs/markdown-design/actions/workflows/release.yml)
+
+An out-of-the-box Markdown rendering component for Vue 3, built on [markdown-it](https://github.com/markdown-it/markdown-it).
+
+## Key Features
+
+🚀 **Core** - Real-time Markdown rendering, table of contents generation, and full-text search
+
+📦 **Builtins** - Includes commonly used Markdown features such as emoji, permalinks, and syntax highlighting
+
+🎨 **Theming** - Replaceable Markdown themes and component styles configurable via CSS variables
+
+🔌 **Plugins** - Compatible with markdown-it plugins for flexible extensibility
+
+📱 **Responsive** - Optimized for both desktop and mobile with responsive layouts
+
+🧩 **Modular** - Import core features on demand and compose components for flexible layouts
+
+🛡️ **Security** - HTML sanitization is enabled by default to mitigate XSS and other attacks
+
+📋 **Typings** - Written in TypeScript with complete type definitions
+
+🧪 **Testing** - Achieves 99% coverage in both E2E and unit tests, ensuring component stability and reliability
 
 ## Quick Start
 
@@ -31,15 +53,15 @@ app.mount('#app')
 ```
 
 ```vue
-<!-- demo.vue -->
+<!-- App.vue -->
 
 <vue-markdown :src="`# Title\nContent`" />
 ```
 
 ## More
 
-More documentation coming soon!
+For detailed documentation, visit https://markdown-design.pages.dev.
 
 ## License
 
-[MIT](./LICENSE).
+Released under the [MIT](./LICENSE) license.

package/README.zh-CN.md

@@ -1,5 +1,7 @@
 # Vue Markdown Design
 
+[![NPM Version](https://img.shields.io/npm/v/vue-markdown-design)](https://www.npmjs.com/package/vue-markdown-design) [![codecov](https://codecov.io/github/ZeroOneJs/markdown-design/graph/badge.svg?token=US6XWJTP8H)](https://codecov.io/github/ZeroOneJs/markdown-design) [![GitHub License](https://img.shields.io/github/license/ZeroOneJs/markdown-design)](https://github.com/ZeroOneJs/markdown-design/blob/main/packages/vue-markdown-design/LICENSE) [![Release](https://github.com/ZeroOneJs/markdown-design/actions/workflows/release.yml/badge.svg)](https://github.com/ZeroOneJs/markdown-design/actions/workflows/release.yml)
+
 一个基于 [markdown-it](https://github.com/markdown-it/markdown-it) 的 Vue 3 开箱即用 Markdown 渲染组件。
 
 ## 主要特性
@@ -20,6 +22,8 @@
 
 📋 **类型提示** - 使用 TypeScript 开发，提供完整的类型定义
 
+🧪 **组件测试** - 端到端和单元测试覆盖率到达 99%，确保组件稳定可靠
+
 ## 快速上手
 
 ### 安装
@@ -54,7 +58,7 @@ app.mount('#app')
 
 ## 更多
 
-详细开发文档请前往 https://markdown-design.pages.dev/zh
+详细开发文档请前往 https://markdown-design.pages.dev/zh-CN
 
 ## 开源协议
 

package/es/_virtual/_@oxc-project_runtime@0.115.0/helpers/asyncToGenerator.mjs

@@ -0,0 +1,27 @@
+//#region \0@oxc-project+runtime@0.115.0/helpers/asyncToGenerator.js
+function asyncGeneratorStep(n, t, e, r, o, a, c) {
+	try {
+		var i = n[a](c), u = i.value;
+	} catch (n) {
+		e(n);
+		return;
+	}
+	i.done ? t(u) : Promise.resolve(u).then(r, o);
+}
+function _asyncToGenerator(n) {
+	return function() {
+		var t = this, e = arguments;
+		return new Promise(function(r, o) {
+			var a = n.apply(t, e);
+			function _next(n) {
+				asyncGeneratorStep(a, r, o, _next, _throw, "next", n);
+			}
+			function _throw(n) {
+				asyncGeneratorStep(a, r, o, _next, _throw, "throw", n);
+			}
+			_next(void 0);
+		});
+	};
+}
+//#endregion
+export { _asyncToGenerator };

package/es/_virtual/_@oxc-project_runtime@0.115.0/helpers/defineProperty.mjs

@@ -0,0 +1,12 @@
+import { toPropertyKey } from "./toPropertyKey.mjs";
+//#region \0@oxc-project+runtime@0.115.0/helpers/defineProperty.js
+function _defineProperty(e, r, t) {
+	return (r = toPropertyKey(r)) in e ? Object.defineProperty(e, r, {
+		value: t,
+		enumerable: !0,
+		configurable: !0,
+		writable: !0
+	}) : e[r] = t, e;
+}
+//#endregion
+export { _defineProperty };

package/es/_virtual/_@oxc-project_runtime@0.115.0/helpers/objectSpread2.mjs

@@ -0,0 +1,25 @@
+import { _defineProperty } from "./defineProperty.mjs";
+//#region \0@oxc-project+runtime@0.115.0/helpers/objectSpread2.js
+function ownKeys(e, r) {
+	var t = Object.keys(e);
+	if (Object.getOwnPropertySymbols) {
+		var o = Object.getOwnPropertySymbols(e);
+		r && (o = o.filter(function(r) {
+			return Object.getOwnPropertyDescriptor(e, r).enumerable;
+		})), t.push.apply(t, o);
+	}
+	return t;
+}
+function _objectSpread2(e) {
+	for (var r = 1; r < arguments.length; r++) {
+		var t = null != arguments[r] ? arguments[r] : {};
+		r % 2 ? ownKeys(Object(t), !0).forEach(function(r) {
+			_defineProperty(e, r, t[r]);
+		}) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function(r) {
+			Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r));
+		});
+	}
+	return e;
+}
+//#endregion
+export { _objectSpread2 };

package/es/_virtual/_@oxc-project_runtime@0.115.0/helpers/objectWithoutProperties.mjs

@@ -0,0 +1,13 @@
+import { _objectWithoutPropertiesLoose } from "./objectWithoutPropertiesLoose.mjs";
+//#region \0@oxc-project+runtime@0.115.0/helpers/objectWithoutProperties.js
+function _objectWithoutProperties(e, t) {
+	if (null == e) return {};
+	var o, r, i = _objectWithoutPropertiesLoose(e, t);
+	if (Object.getOwnPropertySymbols) {
+		var s = Object.getOwnPropertySymbols(e);
+		for (r = 0; r < s.length; r++) o = s[r], t.includes(o) || {}.propertyIsEnumerable.call(e, o) && (i[o] = e[o]);
+	}
+	return i;
+}
+//#endregion
+export { _objectWithoutProperties };

package/es/_virtual/_@oxc-project_runtime@0.115.0/helpers/objectWithoutPropertiesLoose.mjs

@@ -0,0 +1,12 @@
+//#region \0@oxc-project+runtime@0.115.0/helpers/objectWithoutPropertiesLoose.js
+function _objectWithoutPropertiesLoose(r, e) {
+	if (null == r) return {};
+	var t = {};
+	for (var n in r) if ({}.hasOwnProperty.call(r, n)) {
+		if (e.includes(n)) continue;
+		t[n] = r[n];
+	}
+	return t;
+}
+//#endregion
+export { _objectWithoutPropertiesLoose };

package/es/_virtual/_@oxc-project_runtime@0.115.0/helpers/toPrimitive.mjs

@@ -0,0 +1,14 @@
+import { _typeof } from "./typeof.mjs";
+//#region \0@oxc-project+runtime@0.115.0/helpers/toPrimitive.js
+function toPrimitive(t, r) {
+	if ("object" != _typeof(t) || !t) return t;
+	var e = t[Symbol.toPrimitive];
+	if (void 0 !== e) {
+		var i = e.call(t, r || "default");
+		if ("object" != _typeof(i)) return i;
+		throw new TypeError("@@toPrimitive must return a primitive value.");
+	}
+	return ("string" === r ? String : Number)(t);
+}
+//#endregion
+export { toPrimitive };

package/es/_virtual/_@oxc-project_runtime@0.115.0/helpers/toPropertyKey.mjs

@@ -0,0 +1,9 @@
+import { _typeof } from "./typeof.mjs";
+import { toPrimitive } from "./toPrimitive.mjs";
+//#region \0@oxc-project+runtime@0.115.0/helpers/toPropertyKey.js
+function toPropertyKey(t) {
+	var i = toPrimitive(t, "string");
+	return "symbol" == _typeof(i) ? i : i + "";
+}
+//#endregion
+export { toPropertyKey };

package/es/_virtual/_@oxc-project_runtime@0.115.0/helpers/typeof.mjs

@@ -0,0 +1,11 @@
+//#region \0@oxc-project+runtime@0.115.0/helpers/typeof.js
+function _typeof(o) {
+	"@babel/helpers - typeof";
+	return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function(o) {
+		return typeof o;
+	} : function(o) {
+		return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o;
+	}, _typeof(o);
+}
+//#endregion
+export { _typeof };

package/es/hooks/use-element/index.mjs

@@ -1,22 +1,25 @@
-import { useMounted, toValue, unrefElement } from "@vueuse/core";
 import { isString } from "lodash";
 import { shallowRef, watchPostEffect } from "vue";
+import { toValue, unrefElement, useMounted } from "@vueuse/core";
+//#region src/hooks/use-element/index.ts
 function useElement(target) {
-  const targetEl = shallowRef();
-  const isMounted = useMounted();
-  const update = () => {
-    const targetVal = toValue(target);
-    if (!(targetVal && isMounted.value)) return;
-    if (!isString(targetVal)) {
-      targetEl.value = unrefElement(targetVal);
-      return;
-    }
-    targetEl.value = document.querySelector(targetVal);
-    if (!targetEl.value) console.error("[vue-markdown-design] Target does not exist.");
-  };
-  watchPostEffect(update);
-  return { targetEl, update };
+	const targetEl = shallowRef();
+	const isMounted = useMounted();
+	const update = () => {
+		const targetVal = toValue(target);
+		if (!(targetVal && isMounted.value)) return;
+		if (!isString(targetVal)) {
+			targetEl.value = unrefElement(targetVal);
+			return;
+		}
+		targetEl.value = document.querySelector(targetVal);
+		if (!targetEl.value) console.error("[vue-markdown-design] Target does not exist.");
+	};
+	watchPostEffect(update);
+	return {
+		targetEl,
+		update
+	};
 }
-export {
-  useElement
-};
+//#endregion
+export { useElement };

package/es/hooks/use-scroll-element/index.mjs

@@ -1,52 +1,51 @@
-import { unrefElement, useMutationObserver } from "@vueuse/core";
-import { shallowRef, watch, onMounted } from "vue";
 import { allToArray } from "../../utils/format.mjs";
-const tagNames = /* @__PURE__ */ new Set(["HTML", "BODY"]);
-const scrollReg = /scroll|auto|overlay/i;
+import { onMounted, shallowRef, watch } from "vue";
+import { unrefElement, useMutationObserver } from "@vueuse/core";
+//#region src/hooks/use-scroll-element/index.ts
+var tagNames = new Set(["HTML", "BODY"]);
+var scrollReg = /scroll|auto|overlay/i;
 function getScrollElement(el, onlyParent) {
-  let node = el;
-  const nodes = [];
-  while (node.nodeType === 1 && !tagNames.has(node.tagName)) {
-    const { overflowY } = window.getComputedStyle(node);
-    if (scrollReg.test(overflowY)) {
-      nodes.push(node);
-      if (onlyParent) break;
-    }
-    const { parentNode } = node;
-    if (!(parentNode instanceof Element)) break;
-    node = parentNode;
-  }
-  return onlyParent ? nodes[0] : nodes;
+	let node = el;
+	const nodes = [];
+	while (node.nodeType === 1 && !tagNames.has(node.tagName)) {
+		const { overflowY } = window.getComputedStyle(node);
+		if (scrollReg.test(overflowY)) {
+			nodes.push(node);
+			if (onlyParent) break;
+		}
+		const { parentNode } = node;
+		if (!(parentNode instanceof Element)) break;
+		node = parentNode;
+	}
+	return onlyParent ? nodes[0] : nodes;
 }
 function isElement(el) {
-  return [HTMLElement, SVGElement].some((type) => el instanceof type);
+	return [HTMLElement, SVGElement].some((type) => el instanceof type);
 }
 function useScrollParent(target, options = {}) {
-  const { onlyParent = true } = options;
-  const initialValue = onlyParent ? void 0 : [];
-  const scrollEl = shallowRef(initialValue);
-  const update = () => {
-    const el = unrefElement(target);
-    if (!el) {
-      scrollEl.value = initialValue;
-      return;
-    }
-    const scrollElement = getScrollElement(el, onlyParent);
-    if (Array.isArray(scrollElement)) {
-      scrollEl.value = scrollElement.filter(isElement);
-      return;
-    }
-    if (isElement(scrollElement)) {
-      scrollEl.value = scrollElement;
-    }
-  };
-  watch(() => unrefElement(target), update, { flush: "post" });
-  useMutationObserver(() => allToArray(scrollEl.value), update, {
-    attributeFilter: ["style", "class"]
-  });
-  onMounted(update);
-  return { scrollEl, update };
+	const { onlyParent = true } = options;
+	const initialValue = onlyParent ? void 0 : [];
+	const scrollEl = shallowRef(initialValue);
+	const update = () => {
+		const el = unrefElement(target);
+		if (!el) {
+			scrollEl.value = initialValue;
+			return;
+		}
+		const scrollElement = getScrollElement(el, onlyParent);
+		if (Array.isArray(scrollElement)) {
+			scrollEl.value = scrollElement.filter(isElement);
+			return;
+		}
+		if (isElement(scrollElement)) scrollEl.value = scrollElement;
+	};
+	watch(() => unrefElement(target), update, { flush: "post" });
+	useMutationObserver(() => allToArray(scrollEl.value), update, { attributeFilter: ["style", "class"] });
+	onMounted(update);
+	return {
+		scrollEl,
+		update
+	};
 }
-export {
-  useScrollParent
-};
+//#endregion
+export { useScrollParent };

package/es/index.mjs

@@ -1,22 +1,11 @@
-import './style/variables.css';/* empty css                      */
-import { VmdRender } from "./render/index.mjs";
-import { VmdSearch } from "./search/index.mjs";
-import { VmdToc } from "./toc/index.mjs";
-import { VmdSticky } from "./sticky/index.mjs";
-import { VueMarkdown, VueMarkdown as VueMarkdown2 } from "./markdown/index.mjs";
+import './style/variables.css';/* empty css                 */
 import { renderProps } from "./render/Render.mjs";
+import VmdRender from "./render/index2.mjs";
 import { searchProps } from "./search/Search.mjs";
+import VmdSearch from "./search/index2.mjs";
 import { tocProps } from "./toc/Toc.mjs";
+import VmdToc from "./toc/index2.mjs";
+import VmdSticky from "./sticky/index2.mjs";
 import { markdownProps } from "./markdown/Markdown.mjs";
-export {
-  VmdRender,
-  VmdSearch,
-  VmdSticky,
-  VmdToc,
-  VueMarkdown,
-  VueMarkdown2 as default,
-  markdownProps,
-  renderProps,
-  searchProps,
-  tocProps
-};
+import VueMarkdown from "./markdown/index2.mjs";
+export { VmdRender, VmdSearch, VmdSticky, VmdToc, VueMarkdown, VueMarkdown as default, markdownProps, renderProps, searchProps, tocProps };