vue3-markdown-kit 0.1.0

package/lib/theme/github.js

@@ -0,0 +1,111 @@
+// src/core/renderer.js
+import MarkdownIt from "markdown-it";
+import markdownItAttrs from "markdown-it-attrs";
+function escapeHtml(value) {
+  return String(value).replace(/&/g, "&amp;").replace(/</g, "&lt;").replace(/>/g, "&gt;").replace(/"/g, "&quot;");
+}
+function slugifyHeading(value) {
+  const slug = String(value || "").normalize("NFKC").trim().toLowerCase().replace(/\s+/g, "-").replace(/[^\p{Letter}\p{Number}_-]+/gu, "").replace(/-{2,}/g, "-").replace(/^-|-$/g, "");
+  return slug || "section";
+}
+function highlightCode(code, language, options) {
+  const {
+    Hljs,
+    codeHighlightExtensionMap = {},
+    codeBlockClass = (lang) => `v-md-hljs-${lang || ""}`
+  } = options;
+  const normalizedLanguage = codeHighlightExtensionMap[language] || language;
+  let highlighted = escapeHtml(code);
+  if (Hljs && normalizedLanguage && typeof Hljs.getLanguage === "function" && Hljs.getLanguage(normalizedLanguage)) {
+    try {
+      highlighted = Hljs.highlight(code, {
+        language: normalizedLanguage,
+        ignoreIllegals: true
+      }).value;
+    } catch {
+      highlighted = Hljs.highlight(normalizedLanguage, code, true).value;
+    }
+  }
+  return `<pre class="${escapeHtml(codeBlockClass(normalizedLanguage))}"><code>${highlighted}</code></pre>`;
+}
+function installHeadingAnchors(parser) {
+  parser.core.ruler.before("block", "vue_markdown_kit_heading_state", (state) => {
+    state.env.__vueMarkdownKitHeadingSlugs = /* @__PURE__ */ new Map();
+  });
+  const fallback = parser.renderer.rules.heading_open || ((tokens, index, options, _env, self) => self.renderToken(tokens, index, options));
+  parser.renderer.rules.heading_open = (tokens, index, options, env, self) => {
+    const inline = tokens[index + 1];
+    const baseSlug = slugifyHeading(inline && inline.content);
+    const slugs = env.__vueMarkdownKitHeadingSlugs || /* @__PURE__ */ new Map();
+    const count = slugs.get(baseSlug) || 0;
+    const slug = count === 0 ? baseSlug : `${baseSlug}-${count}`;
+    slugs.set(baseSlug, count + 1);
+    env.__vueMarkdownKitHeadingSlugs = slugs;
+    tokens[index].attrSet("id", slug);
+    tokens[index].attrSet("data-v-md-heading", slug);
+    return fallback(tokens, index, options, env, self);
+  };
+}
+function installSafeExternalLinks(parser) {
+  const fallback = parser.renderer.rules.link_open || ((tokens, index, options, _env, self) => self.renderToken(tokens, index, options));
+  parser.renderer.rules.link_open = (tokens, index, options, env, self) => {
+    const token = tokens[index];
+    const href = token.attrGet("href") || "";
+    if (/^https?:\/\//i.test(href)) {
+      token.attrSet("target", "_blank");
+      token.attrSet("rel", "noopener noreferrer");
+    }
+    return fallback(tokens, index, options, env, self);
+  };
+}
+function createMarkdownRenderer(options = {}) {
+  var _a, _b, _c, _d;
+  const parser = new MarkdownIt({
+    html: (_a = options.html) != null ? _a : true,
+    breaks: (_b = options.breaks) != null ? _b : true,
+    linkify: (_c = options.linkify) != null ? _c : false,
+    typographer: (_d = options.typographer) != null ? _d : true,
+    highlight: (code, language) => highlightCode(code, language, options)
+  });
+  if (options.attrs !== false) {
+    parser.use(markdownItAttrs, {
+      leftDelimiter: "{{{",
+      rightDelimiter: "}}}",
+      allowedAttributes: [
+        "class",
+        "height",
+        "id",
+        "title",
+        "width",
+        ...options.allowedAttributes || []
+      ]
+    });
+  }
+  installHeadingAnchors(parser);
+  installSafeExternalLinks(parser);
+  return parser;
+}
+
+// src/theme/github.js
+function createGithubTheme(options = {}) {
+  const markdownParser = createMarkdownRenderer(options);
+  return {
+    name: "github",
+    previewClass: "github-markdown-body",
+    markdownParser,
+    extend(callback) {
+      callback(markdownParser, options.Hljs);
+    }
+  };
+}
+var githubTheme = {
+  install(VMdPreview, options = {}) {
+    VMdPreview.theme(createGithubTheme(options));
+  }
+};
+var github_default = githubTheme;
+export {
+  createGithubTheme,
+  github_default as default
+};
+//# sourceMappingURL=github.js.map

package/lib/theme/github.js.map

@@ -0,0 +1,7 @@
+{
+  "version": 3,
+  "sources": ["../../src/core/renderer.js", "../../src/theme/github.js"],
+  "sourcesContent": ["import MarkdownIt from 'markdown-it'\nimport markdownItAttrs from 'markdown-it-attrs'\n\nfunction escapeHtml(value) {\n  return String(value)\n    .replace(/&/g, '&amp;')\n    .replace(/</g, '&lt;')\n    .replace(/>/g, '&gt;')\n    .replace(/\"/g, '&quot;')\n}\n\nexport function slugifyHeading(value) {\n  const slug = String(value || '')\n    .normalize('NFKC')\n    .trim()\n    .toLowerCase()\n    .replace(/\\s+/g, '-')\n    .replace(/[^\\p{Letter}\\p{Number}_-]+/gu, '')\n    .replace(/-{2,}/g, '-')\n    .replace(/^-|-$/g, '')\n\n  return slug || 'section'\n}\n\nfunction highlightCode(code, language, options) {\n  const {\n    Hljs,\n    codeHighlightExtensionMap = {},\n    codeBlockClass = (lang) => `v-md-hljs-${lang || ''}`,\n  } = options\n\n  const normalizedLanguage = codeHighlightExtensionMap[language] || language\n  let highlighted = escapeHtml(code)\n\n  if (\n    Hljs &&\n    normalizedLanguage &&\n    typeof Hljs.getLanguage === 'function' &&\n    Hljs.getLanguage(normalizedLanguage)\n  ) {\n    try {\n      highlighted = Hljs.highlight(code, {\n        language: normalizedLanguage,\n        ignoreIllegals: true,\n      }).value\n    } catch {\n      // highlight.js 10 compatibility.\n      highlighted = Hljs.highlight(normalizedLanguage, code, true).value\n    }\n  }\n\n  return `<pre class=\"${escapeHtml(codeBlockClass(normalizedLanguage))}\"><code>${highlighted}</code></pre>`\n}\n\nfunction installHeadingAnchors(parser) {\n  parser.core.ruler.before('block', 'vue_markdown_kit_heading_state', (state) => {\n    state.env.__vueMarkdownKitHeadingSlugs = new Map()\n  })\n\n  const fallback =\n    parser.renderer.rules.heading_open ||\n    ((tokens, index, options, _env, self) => self.renderToken(tokens, index, options))\n\n  parser.renderer.rules.heading_open = (tokens, index, options, env, self) => {\n    const inline = tokens[index + 1]\n    const baseSlug = slugifyHeading(inline && inline.content)\n    const slugs = env.__vueMarkdownKitHeadingSlugs || new Map()\n    const count = slugs.get(baseSlug) || 0\n    const slug = count === 0 ? baseSlug : `${baseSlug}-${count}`\n\n    slugs.set(baseSlug, count + 1)\n    env.__vueMarkdownKitHeadingSlugs = slugs\n\n    tokens[index].attrSet('id', slug)\n    tokens[index].attrSet('data-v-md-heading', slug)\n\n    return fallback(tokens, index, options, env, self)\n  }\n}\n\nfunction installSafeExternalLinks(parser) {\n  const fallback =\n    parser.renderer.rules.link_open ||\n    ((tokens, index, options, _env, self) => self.renderToken(tokens, index, options))\n\n  parser.renderer.rules.link_open = (tokens, index, options, env, self) => {\n    const token = tokens[index]\n    const href = token.attrGet('href') || ''\n\n    if (/^https?:\\/\\//i.test(href)) {\n      token.attrSet('target', '_blank')\n      token.attrSet('rel', 'noopener noreferrer')\n    }\n\n    return fallback(tokens, index, options, env, self)\n  }\n}\n\nexport function createMarkdownRenderer(options = {}) {\n  const parser = new MarkdownIt({\n    html: options.html ?? true,\n    breaks: options.breaks ?? true,\n    linkify: options.linkify ?? false,\n    typographer: options.typographer ?? true,\n    highlight: (code, language) => highlightCode(code, language, options),\n  })\n\n  if (options.attrs !== false) {\n    parser.use(markdownItAttrs, {\n      leftDelimiter: '{{{',\n      rightDelimiter: '}}}',\n      allowedAttributes: [\n        'class',\n        'height',\n        'id',\n        'title',\n        'width',\n        ...(options.allowedAttributes || []),\n      ],\n    })\n  }\n\n  installHeadingAnchors(parser)\n  installSafeExternalLinks(parser)\n\n  return parser\n}\n", "import { createMarkdownRenderer } from '../core/renderer.js'\n\nexport function createGithubTheme(options = {}) {\n  const markdownParser = createMarkdownRenderer(options)\n\n  return {\n    name: 'github',\n    previewClass: 'github-markdown-body',\n    markdownParser,\n    extend(callback) {\n      callback(markdownParser, options.Hljs)\n    },\n  }\n}\n\nconst githubTheme = {\n  install(VMdPreview, options = {}) {\n    VMdPreview.theme(createGithubTheme(options))\n  },\n}\n\nexport default githubTheme\n"],
+  "mappings": ";AAAA,OAAO,gBAAgB;AACvB,OAAO,qBAAqB;AAE5B,SAAS,WAAW,OAAO;AACzB,SAAO,OAAO,KAAK,EAChB,QAAQ,MAAM,OAAO,EACrB,QAAQ,MAAM,MAAM,EACpB,QAAQ,MAAM,MAAM,EACpB,QAAQ,MAAM,QAAQ;AAC3B;AAEO,SAAS,eAAe,OAAO;AACpC,QAAM,OAAO,OAAO,SAAS,EAAE,EAC5B,UAAU,MAAM,EAChB,KAAK,EACL,YAAY,EACZ,QAAQ,QAAQ,GAAG,EACnB,QAAQ,gCAAgC,EAAE,EAC1C,QAAQ,UAAU,GAAG,EACrB,QAAQ,UAAU,EAAE;AAEvB,SAAO,QAAQ;AACjB;AAEA,SAAS,cAAc,MAAM,UAAU,SAAS;AAC9C,QAAM;AAAA,IACJ;AAAA,IACA,4BAA4B,CAAC;AAAA,IAC7B,iBAAiB,CAAC,SAAS,aAAa,QAAQ,EAAE;AAAA,EACpD,IAAI;AAEJ,QAAM,qBAAqB,0BAA0B,QAAQ,KAAK;AAClE,MAAI,cAAc,WAAW,IAAI;AAEjC,MACE,QACA,sBACA,OAAO,KAAK,gBAAgB,cAC5B,KAAK,YAAY,kBAAkB,GACnC;AACA,QAAI;AACF,oBAAc,KAAK,UAAU,MAAM;AAAA,QACjC,UAAU;AAAA,QACV,gBAAgB;AAAA,MAClB,CAAC,EAAE;AAAA,IACL,QAAQ;AAEN,oBAAc,KAAK,UAAU,oBAAoB,MAAM,IAAI,EAAE;AAAA,IAC/D;AAAA,EACF;AAEA,SAAO,eAAe,WAAW,eAAe,kBAAkB,CAAC,CAAC,WAAW,WAAW;AAC5F;AAEA,SAAS,sBAAsB,QAAQ;AACrC,SAAO,KAAK,MAAM,OAAO,SAAS,kCAAkC,CAAC,UAAU;AAC7E,UAAM,IAAI,+BAA+B,oBAAI,IAAI;AAAA,EACnD,CAAC;AAED,QAAM,WACJ,OAAO,SAAS,MAAM,iBACrB,CAAC,QAAQ,OAAO,SAAS,MAAM,SAAS,KAAK,YAAY,QAAQ,OAAO,OAAO;AAElF,SAAO,SAAS,MAAM,eAAe,CAAC,QAAQ,OAAO,SAAS,KAAK,SAAS;AAC1E,UAAM,SAAS,OAAO,QAAQ,CAAC;AAC/B,UAAM,WAAW,eAAe,UAAU,OAAO,OAAO;AACxD,UAAM,QAAQ,IAAI,gCAAgC,oBAAI,IAAI;AAC1D,UAAM,QAAQ,MAAM,IAAI,QAAQ,KAAK;AACrC,UAAM,OAAO,UAAU,IAAI,WAAW,GAAG,QAAQ,IAAI,KAAK;AAE1D,UAAM,IAAI,UAAU,QAAQ,CAAC;AAC7B,QAAI,+BAA+B;AAEnC,WAAO,KAAK,EAAE,QAAQ,MAAM,IAAI;AAChC,WAAO,KAAK,EAAE,QAAQ,qBAAqB,IAAI;AAE/C,WAAO,SAAS,QAAQ,OAAO,SAAS,KAAK,IAAI;AAAA,EACnD;AACF;AAEA,SAAS,yBAAyB,QAAQ;AACxC,QAAM,WACJ,OAAO,SAAS,MAAM,cACrB,CAAC,QAAQ,OAAO,SAAS,MAAM,SAAS,KAAK,YAAY,QAAQ,OAAO,OAAO;AAElF,SAAO,SAAS,MAAM,YAAY,CAAC,QAAQ,OAAO,SAAS,KAAK,SAAS;AACvE,UAAM,QAAQ,OAAO,KAAK;AAC1B,UAAM,OAAO,MAAM,QAAQ,MAAM,KAAK;AAEtC,QAAI,gBAAgB,KAAK,IAAI,GAAG;AAC9B,YAAM,QAAQ,UAAU,QAAQ;AAChC,YAAM,QAAQ,OAAO,qBAAqB;AAAA,IAC5C;AAEA,WAAO,SAAS,QAAQ,OAAO,SAAS,KAAK,IAAI;AAAA,EACnD;AACF;AAEO,SAAS,uBAAuB,UAAU,CAAC,GAAG;AAlGrD;AAmGE,QAAM,SAAS,IAAI,WAAW;AAAA,IAC5B,OAAM,aAAQ,SAAR,YAAgB;AAAA,IACtB,SAAQ,aAAQ,WAAR,YAAkB;AAAA,IAC1B,UAAS,aAAQ,YAAR,YAAmB;AAAA,IAC5B,cAAa,aAAQ,gBAAR,YAAuB;AAAA,IACpC,WAAW,CAAC,MAAM,aAAa,cAAc,MAAM,UAAU,OAAO;AAAA,EACtE,CAAC;AAED,MAAI,QAAQ,UAAU,OAAO;AAC3B,WAAO,IAAI,iBAAiB;AAAA,MAC1B,eAAe;AAAA,MACf,gBAAgB;AAAA,MAChB,mBAAmB;AAAA,QACjB;AAAA,QACA;AAAA,QACA;AAAA,QACA;AAAA,QACA;AAAA,QACA,GAAI,QAAQ,qBAAqB,CAAC;AAAA,MACpC;AAAA,IACF,CAAC;AAAA,EACH;AAEA,wBAAsB,MAAM;AAC5B,2BAAyB,MAAM;AAE/B,SAAO;AACT;;;AC5HO,SAAS,kBAAkB,UAAU,CAAC,GAAG;AAC9C,QAAM,iBAAiB,uBAAuB,OAAO;AAErD,SAAO;AAAA,IACL,MAAM;AAAA,IACN,cAAc;AAAA,IACd;AAAA,IACA,OAAO,UAAU;AACf,eAAS,gBAAgB,QAAQ,IAAI;AAAA,IACvC;AAAA,EACF;AACF;AAEA,IAAM,cAAc;AAAA,EAClB,QAAQ,YAAY,UAAU,CAAC,GAAG;AAChC,eAAW,MAAM,kBAAkB,OAAO,CAAC;AAAA,EAC7C;AACF;AAEA,IAAO,iBAAQ;",
+  "names": []
+}

package/lib/theme/style/github.css

@@ -0,0 +1,187 @@
+.github-markdown-body {
+  color: #1f2328;
+  background: #fff;
+  font-family:
+    -apple-system,
+    BlinkMacSystemFont,
+    "Segoe UI",
+    Helvetica,
+    Arial,
+    sans-serif,
+    "Apple Color Emoji",
+    "Segoe UI Emoji";
+  font-size: 16px;
+  line-height: 1.5;
+  overflow-wrap: break-word;
+}
+
+.github-markdown-body::before,
+.github-markdown-body::after {
+  display: table;
+  content: "";
+}
+
+.github-markdown-body::after {
+  clear: both;
+}
+
+.github-markdown-body > :first-child {
+  margin-top: 0 !important;
+}
+
+.github-markdown-body > :last-child {
+  margin-bottom: 0 !important;
+}
+
+.github-markdown-body a {
+  color: #0969da;
+  text-decoration: none;
+}
+
+.github-markdown-body a:hover {
+  text-decoration: underline;
+}
+
+.github-markdown-body h1,
+.github-markdown-body h2,
+.github-markdown-body h3,
+.github-markdown-body h4,
+.github-markdown-body h5,
+.github-markdown-body h6 {
+  margin-top: 24px;
+  margin-bottom: 16px;
+  font-weight: 600;
+  line-height: 1.25;
+}
+
+.github-markdown-body h1,
+.github-markdown-body h2 {
+  padding-bottom: 0.3em;
+  border-bottom: 1px solid #d8dee4;
+}
+
+.github-markdown-body h1 {
+  font-size: 2em;
+}
+
+.github-markdown-body h2 {
+  font-size: 1.5em;
+}
+
+.github-markdown-body h3 {
+  font-size: 1.25em;
+}
+
+.github-markdown-body p,
+.github-markdown-body blockquote,
+.github-markdown-body ul,
+.github-markdown-body ol,
+.github-markdown-body table,
+.github-markdown-body pre {
+  margin-top: 0;
+  margin-bottom: 16px;
+}
+
+.github-markdown-body blockquote {
+  padding: 0 1em;
+  color: #59636e;
+  border-left: 0.25em solid #d1d9e0;
+}
+
+.github-markdown-body ul,
+.github-markdown-body ol {
+  padding-left: 2em;
+}
+
+.github-markdown-body hr {
+  height: 0.25em;
+  padding: 0;
+  margin: 24px 0;
+  background-color: #d1d9e0;
+  border: 0;
+}
+
+.github-markdown-body table {
+  display: block;
+  width: max-content;
+  max-width: 100%;
+  overflow: auto;
+  border-spacing: 0;
+  border-collapse: collapse;
+}
+
+.github-markdown-body table th,
+.github-markdown-body table td {
+  padding: 6px 13px;
+  border: 1px solid #d1d9e0;
+}
+
+.github-markdown-body table th {
+  font-weight: 600;
+  background: #f6f8fa;
+}
+
+.github-markdown-body table tr:nth-child(2n) {
+  background-color: #f6f8fa;
+}
+
+.github-markdown-body code {
+  padding: 0.2em 0.4em;
+  margin: 0;
+  font-family:
+    ui-monospace,
+    SFMono-Regular,
+    SF Mono,
+    Menlo,
+    Consolas,
+    "Liberation Mono",
+    monospace;
+  font-size: 85%;
+  background-color: rgba(175, 184, 193, 0.2);
+  border-radius: 6px;
+}
+
+.github-markdown-body pre {
+  padding: 16px;
+  line-height: 1.45;
+  background-color: #f6f8fa;
+  border-radius: 6px;
+}
+
+.github-markdown-body pre code {
+  display: inline;
+  padding: 0;
+  margin: 0;
+  overflow: visible;
+  font-size: 100%;
+  line-height: inherit;
+  word-break: normal;
+  white-space: pre;
+  background: transparent;
+  border: 0;
+}
+
+.github-markdown-body img {
+  max-width: 100%;
+  height: auto;
+}
+
+.github-markdown-body .hljs-keyword,
+.github-markdown-body .hljs-selector-tag,
+.github-markdown-body .hljs-literal {
+  color: #cf222e;
+}
+
+.github-markdown-body .hljs-string,
+.github-markdown-body .hljs-attr {
+  color: #0a3069;
+}
+
+.github-markdown-body .hljs-title,
+.github-markdown-body .hljs-function {
+  color: #8250df;
+}
+
+.github-markdown-body .hljs-comment {
+  color: #6e7781;
+}

package/package.json

@@ -0,0 +1,112 @@
+{
+  "name": "vue3-markdown-kit",
+  "version": "0.1.0",
+  "description": "A small, auditable Markdown preview toolkit for Vue 3.5.",
+  "keywords": [
+    "vue",
+    "vue3",
+    "vue3.5",
+    "markdown",
+    "preview",
+    "renderer",
+    "markdown-it"
+  ],
+  "license": "MIT",
+  "author": "eatmeatHJ",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/eatmeatHJ/vue3-markdown-kit.git"
+  },
+  "bugs": {
+    "url": "https://github.com/eatmeatHJ/vue3-markdown-kit/issues"
+  },
+  "homepage": "https://github.com/eatmeatHJ/vue3-markdown-kit#readme",
+  "type": "module",
+  "main": "./lib/index.cjs",
+  "module": "./lib/index.js",
+  "types": "./types/index.d.ts",
+  "files": [
+    "lib",
+    "types",
+    "LICENSE",
+    "NOTICE.md",
+    "README.md",
+    "CHANGELOG.md",
+    "SECURITY.md"
+  ],
+  "exports": {
+    ".": {
+      "types": "./types/index.d.ts",
+      "import": "./lib/index.js",
+      "require": "./lib/index.cjs"
+    },
+    "./preview": {
+      "types": "./types/preview.d.ts",
+      "import": "./lib/preview.js",
+      "require": "./lib/preview.cjs"
+    },
+    "./core": {
+      "types": "./types/core.d.ts",
+      "import": "./lib/core.js",
+      "require": "./lib/core.cjs"
+    },
+    "./theme/github": {
+      "types": "./types/theme-github.d.ts",
+      "import": "./lib/theme/github.js",
+      "require": "./lib/theme/github.cjs"
+    },
+    "./style/preview.css": "./lib/style/preview.css",
+    "./theme/style/github.css": "./lib/theme/style/github.css",
+    "./lib/preview": {
+      "types": "./types/preview.d.ts",
+      "import": "./lib/preview.js",
+      "require": "./lib/preview.cjs"
+    },
+    "./lib/preview.js": {
+      "types": "./types/preview.d.ts",
+      "import": "./lib/preview.js",
+      "require": "./lib/preview.cjs"
+    },
+    "./lib/theme/github": {
+      "types": "./types/theme-github.d.ts",
+      "import": "./lib/theme/github.js",
+      "require": "./lib/theme/github.cjs"
+    },
+    "./lib/theme/github.js": {
+      "types": "./types/theme-github.d.ts",
+      "import": "./lib/theme/github.js",
+      "require": "./lib/theme/github.cjs"
+    },
+    "./lib/style/preview.css": "./lib/style/preview.css",
+    "./lib/theme/style/github.css": "./lib/theme/style/github.css",
+    "./package.json": "./package.json"
+  },
+  "sideEffects": [
+    "**/*.css"
+  ],
+  "scripts": {
+    "build": "node scripts/build.mjs",
+    "test": "npm run build && node --test && npm run test:types",
+    "test:types": "tsc -p tsconfig.types.json",
+    "check": "npm run test && npm pack --dry-run",
+    "prepublishOnly": "npm run check"
+  },
+  "dependencies": {
+    "dompurify": "3.4.15",
+    "highlight.js": "11.11.1",
+    "markdown-it": "14.3.0",
+    "markdown-it-attrs": "5.0.1"
+  },
+  "peerDependencies": {
+    "vue": "^3.5.0"
+  },
+  "devDependencies": {
+    "esbuild": "0.28.1",
+    "jsdom": "26.0.0",
+    "typescript": "7.0.2",
+    "vue": "3.5.38"
+  },
+  "engines": {
+    "node": ">=18"
+  }
+}

package/types/core.d.ts

@@ -0,0 +1,40 @@
+import type { Config as DOMPurifyConfig } from 'dompurify'
+
+export interface MarkdownRenderer {
+  render(source: string, environment?: Record<string, unknown>): string
+  use(plugin: unknown, ...options: unknown[]): this
+  set(options: Record<string, unknown>): this
+  renderer: {
+    rules: Record<string, unknown>
+  }
+}
+
+export interface MarkdownRendererOptions {
+  Hljs?: unknown
+  html?: boolean
+  breaks?: boolean
+  linkify?: boolean
+  typographer?: boolean
+  attrs?: boolean
+  allowedAttributes?: string[]
+  codeHighlightExtensionMap?: Record<string, string>
+  codeBlockClass?: (language?: string) => string
+}
+
+export function createMarkdownRenderer(
+  options?: MarkdownRendererOptions,
+): MarkdownRenderer
+
+export function slugifyHeading(value: string): string
+
+export function sanitizeHtml(
+  dirtyHtml: string,
+  options?: DOMPurifyConfig,
+  windowLike?: Window,
+): string
+
+export const sanitizer: {
+  process(dirtyHtml: string, options?: DOMPurifyConfig): string
+  extend(options?: DOMPurifyConfig): typeof sanitizer
+  reset(): typeof sanitizer
+}

package/types/index.d.ts

@@ -0,0 +1,20 @@
+import type { Plugin } from 'vue'
+import type { MarkdownRendererOptions } from './core'
+import type { MarkdownTheme } from './preview'
+
+export { default as VMdPreview } from './preview'
+export * from './core'
+
+export function createGithubTheme(
+  options?: MarkdownRendererOptions,
+): MarkdownTheme
+
+export const githubTheme: {
+  install(preview: unknown, options?: MarkdownRendererOptions): void
+}
+
+export const VueMarkdownKit: Plugin & {
+  version: string
+}
+
+export default VueMarkdownKit

package/types/preview.d.ts

@@ -0,0 +1,39 @@
+import type { App, DefineComponent } from 'vue'
+import type { Config as DOMPurifyConfig } from 'dompurify'
+import type { MarkdownRenderer } from './core'
+
+export interface MarkdownTheme {
+  name?: string
+  previewClass: string
+  markdownParser: MarkdownRenderer
+  extend(
+    callback: (parser: MarkdownRenderer, highlighter?: unknown) => void,
+  ): void
+}
+
+export interface VMdPreviewPlugin {
+  name: 'v-md-preview'
+  version: string
+  install(app: App): void
+  theme(theme: MarkdownTheme): this
+  use(theme: unknown, options?: unknown): this
+  extendMarkdown(extender: (parser: MarkdownRenderer) => void): this
+  xss: {
+    process(dirtyHtml: string, options?: DOMPurifyConfig): string
+    extend(options?: DOMPurifyConfig): unknown
+    reset(): unknown
+  }
+}
+
+export type VMdPreviewComponent = DefineComponent<{
+  text?: string
+  theme?: MarkdownTheme
+  tabSize?: number
+  scrollContainer?: () => unknown
+  top?: number
+  sanitizeOptions?: DOMPurifyConfig
+}> & VMdPreviewPlugin
+
+declare const VMdPreview: VMdPreviewComponent
+
+export default VMdPreview

package/types/theme-github.d.ts

@@ -0,0 +1,15 @@
+import type { MarkdownRendererOptions } from './core'
+import type { MarkdownTheme, VMdPreviewComponent } from './preview'
+
+export function createGithubTheme(
+  options?: MarkdownRendererOptions,
+): MarkdownTheme
+
+declare const githubTheme: {
+  install(
+    preview: VMdPreviewComponent,
+    options?: MarkdownRendererOptions,
+  ): void
+}
+
+export default githubTheme