@shikijs/markdown-it 1.0.0-beta.0

package/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2021 Pine Wu
+Copyright (c) 2023 Anthony Fu <https://github.com/antfu>
+
+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:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+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.

package/README.md

@@ -0,0 +1,9 @@
+# @shikijs/markdown-it
+
+[Markdown It](https://markdown-it.github.io/) plugin for [shiki](https://github.com/shikijs/shiki)
+
+[Documentation](https://shiki.style/packages/markdown-it)
+
+## License
+
+MIT

package/dist/core.d.mts

@@ -0,0 +1,22 @@
+import MarkdownIt from 'markdown-it';
+import { CodeOptionsThemes, BuiltinTheme, TransformerOptions, CodeOptionsMeta, HighlighterGeneric } from 'shiki';
+
+interface MarkdownItShikiExtraOptions {
+    /**
+     * Add `highlighted` class to lines defined in after codeblock
+     *
+     * @deprecated Use [transformerNotationHighlight](https://shiki.style/packages/transformers#transformernotationhighlight) instead
+     * @default false
+     */
+    highlightLines?: boolean | string;
+    /**
+     * Custom meta string parser
+     * Return an object to merge with `meta`
+     */
+    parseMetaString?: (metaString: string, code: string, lang: string) => Record<string, any> | undefined | null;
+}
+type MarkdownItShikiSetupOptions = CodeOptionsThemes<BuiltinTheme> & TransformerOptions & CodeOptionsMeta & MarkdownItShikiExtraOptions;
+declare function setupMarkdownIt(markdownit: MarkdownIt, highlighter: HighlighterGeneric<any, any>, options: MarkdownItShikiSetupOptions): void;
+declare function fromHighlighter(highlighter: HighlighterGeneric<any, any>, options: MarkdownItShikiSetupOptions): (markdownit: MarkdownIt) => void;
+
+export { type MarkdownItShikiExtraOptions, type MarkdownItShikiSetupOptions, fromHighlighter, setupMarkdownIt };

package/dist/core.d.ts

@@ -0,0 +1,22 @@
+import MarkdownIt from 'markdown-it';
+import { CodeOptionsThemes, BuiltinTheme, TransformerOptions, CodeOptionsMeta, HighlighterGeneric } from 'shiki';
+
+interface MarkdownItShikiExtraOptions {
+    /**
+     * Add `highlighted` class to lines defined in after codeblock
+     *
+     * @deprecated Use [transformerNotationHighlight](https://shiki.style/packages/transformers#transformernotationhighlight) instead
+     * @default false
+     */
+    highlightLines?: boolean | string;
+    /**
+     * Custom meta string parser
+     * Return an object to merge with `meta`
+     */
+    parseMetaString?: (metaString: string, code: string, lang: string) => Record<string, any> | undefined | null;
+}
+type MarkdownItShikiSetupOptions = CodeOptionsThemes<BuiltinTheme> & TransformerOptions & CodeOptionsMeta & MarkdownItShikiExtraOptions;
+declare function setupMarkdownIt(markdownit: MarkdownIt, highlighter: HighlighterGeneric<any, any>, options: MarkdownItShikiSetupOptions): void;
+declare function fromHighlighter(highlighter: HighlighterGeneric<any, any>, options: MarkdownItShikiSetupOptions): (markdownit: MarkdownIt) => void;
+
+export { type MarkdownItShikiExtraOptions, type MarkdownItShikiSetupOptions, fromHighlighter, setupMarkdownIt };

package/dist/core.mjs

@@ -0,0 +1,51 @@
+import { transformerMetaHighlight } from '@shikijs/transformers';
+
+function setupMarkdownIt(markdownit, highlighter, options) {
+  const {
+    highlightLines = false,
+    parseMetaString
+  } = options;
+  markdownit.options.highlight = (code, lang = "text", attrs) => {
+    const meta = parseMetaString?.(attrs, code, lang) || {};
+    const codeOptions = {
+      ...options,
+      lang,
+      meta: {
+        ...options.meta,
+        ...meta,
+        __raw: attrs
+      }
+    };
+    const builtInTransformer = [];
+    if (highlightLines) {
+      builtInTransformer.push(
+        transformerMetaHighlight({
+          className: highlightLines === true ? "highlighted" : highlightLines
+        })
+      );
+    }
+    builtInTransformer.push({
+      name: "@shikijs/markdown-it:block-class",
+      code(node) {
+        node.properties.class = `language-${lang}`;
+      }
+    });
+    return highlighter.codeToHtml(
+      code,
+      {
+        ...codeOptions,
+        transformers: [
+          ...builtInTransformer,
+          ...codeOptions.transformers || []
+        ]
+      }
+    );
+  };
+}
+function fromHighlighter(highlighter, options) {
+  return function(markdownit) {
+    setupMarkdownIt(markdownit, highlighter, options);
+  };
+}
+
+export { fromHighlighter, setupMarkdownIt };

package/dist/index.d.mts

@@ -0,0 +1,16 @@
+import MarkdownIt from 'markdown-it';
+import { LanguageInput, BuiltinLanguage } from 'shiki';
+import { MarkdownItShikiSetupOptions } from './core.mjs';
+export { MarkdownItShikiExtraOptions, fromHighlighter, setupMarkdownIt } from './core.mjs';
+
+type MarkdownItShikiOptions = MarkdownItShikiSetupOptions & {
+    /**
+     * Language names to include.
+     *
+     * @default Object.keys(bundledLanguages)
+     */
+    langs?: Array<LanguageInput | BuiltinLanguage>;
+};
+declare function markdownItShiki(options: MarkdownItShikiOptions): Promise<(markdownit: MarkdownIt) => void>;
+
+export { type MarkdownItShikiOptions, MarkdownItShikiSetupOptions, markdownItShiki as default };

package/dist/index.d.ts

@@ -0,0 +1,16 @@
+import MarkdownIt from 'markdown-it';
+import { LanguageInput, BuiltinLanguage } from 'shiki';
+import { MarkdownItShikiSetupOptions } from './core.js';
+export { MarkdownItShikiExtraOptions, fromHighlighter, setupMarkdownIt } from './core.js';
+
+type MarkdownItShikiOptions = MarkdownItShikiSetupOptions & {
+    /**
+     * Language names to include.
+     *
+     * @default Object.keys(bundledLanguages)
+     */
+    langs?: Array<LanguageInput | BuiltinLanguage>;
+};
+declare function markdownItShiki(options: MarkdownItShikiOptions): Promise<(markdownit: MarkdownIt) => void>;
+
+export { type MarkdownItShikiOptions, MarkdownItShikiSetupOptions, markdownItShiki as default };

package/dist/index.mjs

@@ -0,0 +1,17 @@
+import { getHighlighter, bundledLanguages } from 'shiki';
+import { setupMarkdownIt } from './core.mjs';
+export { fromHighlighter } from './core.mjs';
+import '@shikijs/transformers';
+
+async function markdownItShiki(options) {
+  const themeNames = ("themes" in options ? Object.values(options.themes) : [options.theme]).filter(Boolean);
+  const highlighter = await getHighlighter({
+    themes: themeNames,
+    langs: options.langs || Object.keys(bundledLanguages)
+  });
+  return function(markdownit) {
+    setupMarkdownIt(markdownit, highlighter, options);
+  };
+}
+
+export { markdownItShiki as default, setupMarkdownIt };

package/package.json

@@ -0,0 +1,59 @@
+{
+  "name": "@shikijs/markdown-it",
+  "type": "module",
+  "version": "1.0.0-beta.0",
+  "description": "markdown-it integration for shiki",
+  "author": "Anthony Fu <anthonyfu117@hotmail.com>",
+  "license": "MIT",
+  "homepage": "https://github.com/shikijs/shiki#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/shikijs/shiki.git",
+    "directory": "packages/markdown-it"
+  },
+  "bugs": "https://github.com/shikijs/shiki/issues",
+  "keywords": [
+    "shiki",
+    "markdown-it"
+  ],
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.mts",
+      "default": "./dist/index.mjs"
+    },
+    "./core": {
+      "types": "./dist/core.d.mts",
+      "default": "./dist/core.mjs"
+    }
+  },
+  "main": "./dist/index.mjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.mts",
+  "typesVersions": {
+    "*": {
+      "core": [
+        "./dist/core.d.mts"
+      ],
+      "*": [
+        "./dist/*",
+        "./*"
+      ]
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "markdown-it": "^14.0.0",
+    "@shikijs/transformers": "1.0.0-beta.0",
+    "shiki": "1.0.0-beta.0"
+  },
+  "devDependencies": {
+    "@types/markdown-it": "^13.0.7"
+  },
+  "scripts": {
+    "build": "unbuild",
+    "dev": "unbuild --stub"
+  }
+}