zenn-markdown-html 0.1.111-alpha.3 → 0.1.112

package/README.md

@@ -1,11 +1,20 @@
 # Zenn Markdown Html
-Convert markdown text to html.
 
-## how to use
+マークダウンを HTML へ変換するためのライブラリ。
+
+## 使い方
 
 ```js
-import markdownToHtml from "zenn-markdown-html";
+import markdownToHtml from 'zenn-markdown-html';
 const html = markdownToHtml(markdown);
 ```
 
+## 使用できる Markdown の記法について
+
+- [Zenn の Markdown 記法一覧 | Zenn](https://zenn.dev/zenn/articles/markdown-guide)
+
+## 開発者向けのドキュメント
+
+## Babel の使用について
 
+`zenn-markdown-html` では、PrismJS の言語プラグインを予め全て読み込むために `babel-plugin-prismjs` を使用しているため、ソースコードのビルドには `babel` を使用し、型ファイル(\*.d.ts)のビルドには `tsc` を使用してビルドしています。

package/lib/index.js

@@ -1,80 +1,89 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-var markdown_it_1 = __importDefault(require("markdown-it"));
-var crypto_1 = __importDefault(require("crypto"));
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.default = void 0;
+
+var _markdownIt = _interopRequireDefault(require("markdown-it"));
+
+var _crypto = _interopRequireDefault(require("crypto"));
+
+var _mdContainer = require("./utils/md-container");
+
+var _mdRendererFence = require("./utils/md-renderer-fence");
+
+var _mdLinkifyToCard = require("./utils/md-linkify-to-card");
+
+var _mdKatex = require("./utils/md-katex");
+
+var _mdBr = require("./utils/md-br");
+
+var _mdCustomBlock = require("./utils/md-custom-block");
+
+var _markdownItImsize = _interopRequireDefault(require("@steelydylan/markdown-it-imsize"));
+
+var _markdownItAnchor = _interopRequireDefault(require("markdown-it-anchor"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
 // plugis
-var md_container_1 = require("./utils/md-container");
-var md_renderer_fence_1 = require("./utils/md-renderer-fence");
-var md_linkify_to_card_1 = require("./utils/md-linkify-to-card");
-var md_katex_1 = require("./utils/md-katex");
-var md_br_1 = require("./utils/md-br");
-var md_custom_block_1 = require("./utils/md-custom-block");
-var markdown_it_imsize_1 = __importDefault(require("@steelydylan/markdown-it-imsize"));
-var markdown_it_anchor_1 = __importDefault(require("markdown-it-anchor"));
-var mdContainer = require('markdown-it-container');
-var mdFootnote = require('markdown-it-footnote');
-var mdTaskLists = require('markdown-it-task-lists');
-var mdInlineComments = require('markdown-it-inline-comments');
-var mdLinkAttributes = require('markdown-it-link-attributes');
-var md = (0, markdown_it_1.default)({
-    breaks: true,
-    linkify: true,
+const mdContainer = require('markdown-it-container');
+
+const mdFootnote = require('markdown-it-footnote');
+
+const mdTaskLists = require('markdown-it-task-lists');
+
+const mdInlineComments = require('markdown-it-inline-comments');
+
+const mdLinkAttributes = require('markdown-it-link-attributes');
+
+const md = (0, _markdownIt.default)({
+  breaks: true,
+  linkify: true
 });
-md.linkify.set({ fuzzyLink: false });
-md.use(md_br_1.mdBr)
-    .use(md_renderer_fence_1.mdRendererFence)
-    .use(markdown_it_imsize_1.default)
-    .use(md_custom_block_1.mdCustomBlock)
-    .use(mdContainer, 'details', md_container_1.containerDetailsOptions)
-    .use(mdContainer, 'message', md_container_1.containerMessageOptions)
-    .use(mdFootnote)
-    .use(mdTaskLists, { enabled: true })
-    .use(mdInlineComments)
-    .use(mdLinkAttributes, [
-    // 内部リンク
-    {
-        pattern: /^(?:https:\/\/zenn\.dev$)|(?:https:\/\/zenn\.dev\/.*$)/,
-        attrs: {
-            target: '_blank',
-        },
-    },
-    // 外部リンク
-    {
-        pattern: /^https?:\/\//,
-        attrs: {
-            target: '_blank',
-            rel: 'nofollow noopener noreferrer',
-        },
-    },
-])
-    .use(markdown_it_anchor_1.default, {
-    level: [1, 2, 3, 4],
-    permalink: markdown_it_anchor_1.default.permalink.ariaHidden({
-        placement: 'before',
-        class: 'header-anchor-link',
-        symbol: '',
-    }),
-    tabIndex: false,
-})
-    .use(md_katex_1.mdKatex)
-    .use(md_linkify_to_card_1.mdLinkifyToCard);
-// custom footnote
-md.renderer.rules.footnote_block_open = function () {
-    return '<section class="footnotes">\n' +
-        '<div class="footnotes-title">脚注</div>\n' +
-        '<ol class="footnotes-list">\n';
-};
-var markdownToHtml = function (text) {
-    if (!(text && text.length))
-        return '';
-    // docIdは複数のコメントが1ページに指定されたときに脚注のリンク先が重複しないように指定する
-    // 1ページの中で重複しなければ問題ないため、ごく短いランダムな文字列とする
-    // - https://github.com/zenn-dev/zenn-community/issues/356
-    // - https://github.com/markdown-it/markdown-it-footnote/pull/8
-    var docId = crypto_1.default.randomBytes(2).toString('hex');
-    return md.render(text, { docId: docId });
+md.linkify.set({
+  fuzzyLink: false
+});
+md.use(_mdBr.mdBr).use(_mdRendererFence.mdRendererFence).use(_markdownItImsize.default).use(_mdCustomBlock.mdCustomBlock).use(mdContainer, 'details', _mdContainer.containerDetailsOptions).use(mdContainer, 'message', _mdContainer.containerMessageOptions).use(mdFootnote).use(mdTaskLists, {
+  enabled: true
+}).use(mdInlineComments).use(mdLinkAttributes, [// 内部リンク
+{
+  pattern: /^(?:https:\/\/zenn\.dev$)|(?:https:\/\/zenn\.dev\/.*$)/,
+  attrs: {
+    target: '_blank'
+  }
+}, // 外部リンク
+{
+  pattern: /^https?:\/\//,
+  attrs: {
+    target: '_blank',
+    rel: 'nofollow noopener noreferrer'
+  }
+}]).use(_markdownItAnchor.default, {
+  level: [1, 2, 3, 4],
+  permalink: _markdownItAnchor.default.permalink.ariaHidden({
+    placement: 'before',
+    class: 'header-anchor-link',
+    symbol: ''
+  }),
+  tabIndex: false
+}).use(_mdKatex.mdKatex).use(_mdLinkifyToCard.mdLinkifyToCard); // custom footnote
+
+md.renderer.rules.footnote_block_open = () => '<section class="footnotes">\n' + '<div class="footnotes-title">脚注</div>\n' + '<ol class="footnotes-list">\n';
+
+const markdownToHtml = text => {
+  if (!(text && text.length)) return ''; // docIdは複数のコメントが1ページに指定されたときに脚注のリンク先が重複しないように指定する
+  // 1ページの中で重複しなければ問題ないため、ごく短いランダムな文字列とする
+  // - https://github.com/zenn-dev/zenn-community/issues/356
+  // - https://github.com/markdown-it/markdown-it-footnote/pull/8
+
+  const docId = _crypto.default.randomBytes(2).toString('hex');
+
+  return md.render(text, {
+    docId
+  });
 };
-exports.default = markdownToHtml;
+
+var _default = markdownToHtml;
+exports.default = _default;

package/lib/prism-plugins/prism-diff-highlight.d.ts

@@ -2,5 +2,6 @@
  * PrismJSのDiff構文を使用できるようにするためのプラグイン
  * ソースコードの大部分は、以下のファイルより抜き出したもの
  * @reference https://github.com/PrismJS/prism/blob/master/plugins/diff-highlight/prism-diff-highlight.js
+ * @note `babel-plugin-prismjs`によって全ての言語プラグインを読み込んでいるため`locaLanguages()`の実行はしていない
  */
 export declare function enableDiffHighlight(): void;