@cobapen/markdown 0.1.0 → 0.3.0

package/README.md

@@ -2,11 +2,16 @@
 
 A markdown converter for the cobapen website. 
 
+[![Build/Test](https://github.com/cobapen/markdown/actions/workflows/actions.yml/badge.svg?branch=main)](https://github.com/cobapen/markdown/actions/workflows/actions.yml)
+
+https://cobapen.github.io/markdown
+
 ## Features
 
 - toc
 - anchor & footnote 
 - deflist
-- fenced code block with filename, line-number
+- fenced code block with filename, line-number support
+- server side syntax highlighting
 - server side math rendering
 

package/dist/code/fence-custom.d.ts

@@ -2,7 +2,7 @@ import { Options } from "markdown-it/index.mjs";
 import Renderer from "markdown-it/lib/renderer.mjs";
 import Token from "markdown-it/lib/token.mjs";
 interface Env {
-    showCodeTitleByDefault?: boolean;
+  showCodeTitleByDefault?: boolean;
 }
 /**
  * Custom fence renderer for markdown-it.

package/dist/code/fence-custom.js

@@ -6,46 +6,46 @@ import { InfoString } from "./info-string.js";
  * see: markdown-it/lib/renderer.mjs
  */
 export function fence_custom(tokens, idx, options, env, slf) {
-    var token = tokens[idx];
-    var info_str = token.info ? unescapeAll(token.info).trim() : "";
-    var info = new InfoString(info_str);
-    var langName = info.lang;
-    var langAttrs = info.attrs.join(" ");
-    var highlighted;
-    if (options.highlight) {
-        highlighted = options.highlight(token.content, langName, langAttrs) || escapeHtml(token.content);
+  const token = tokens[idx];
+  const info_str = token.info ? unescapeAll(token.info).trim() : "";
+  const info = new InfoString(info_str);
+  const langName = info.lang;
+  const langAttrs = info.attrs.join(" ");
+  let highlighted;
+  if (options.highlight) {
+    highlighted = options.highlight(token.content, langName, langAttrs) || escapeHtml(token.content);
+  }
+  else {
+    highlighted = escapeHtml(token.content);
+  }
+  if (highlighted.indexOf("<pre") === 0) {
+    return highlighted + "\n";
+  }
+  // If language exists, inject class gently, without modifying original token.
+  // May be, one day we will add .deepClone() for token and simplify this part, but
+  // now we prefer to keep things local.
+  if (info.hasLang) {
+    const i = token.attrIndex("class");
+    const tmpAttrs = token.attrs ? token.attrs.slice() : [];
+    if (i < 0) {
+      tmpAttrs.push(["class", options.langPrefix + langName]);
     }
     else {
-        highlighted = escapeHtml(token.content);
+      tmpAttrs[i] = tmpAttrs[i].slice();
+      tmpAttrs[i][1] += " " + options.langPrefix + langName;
     }
-    if (highlighted.indexOf("<pre") === 0) {
-        return highlighted + "\n";
+    // Fake token just to render attributes
+    const tmpToken = {
+      attrs: tmpAttrs
+    };
+    if (info.title.length > 0) {
+      const style = (env.showCodeTitleByDefault === true)
+        ? ""
+        : " style=\"visibility:hidden;\"";
+      return `<pre><code${slf.renderAttrs(tmpToken)}>${highlighted}</code><span class="title"${style}>${info.title}</span></pre>\n`;
     }
-    // If language exists, inject class gently, without modifying original token.
-    // May be, one day we will add .deepClone() for token and simplify this part, but
-    // now we prefer to keep things local.
-    if (info.hasLang) {
-        var i = token.attrIndex("class");
-        var tmpAttrs = token.attrs ? token.attrs.slice() : [];
-        if (i < 0) {
-            tmpAttrs.push(["class", options.langPrefix + langName]);
-        }
-        else {
-            tmpAttrs[i] = tmpAttrs[i].slice();
-            tmpAttrs[i][1] += " " + options.langPrefix + langName;
-        }
-        // Fake token just to render attributes
-        var tmpToken = {
-            attrs: tmpAttrs
-        };
-        if (info.title.length > 0) {
-            var style = (env.showCodeTitleByDefault === true)
-                ? ""
-                : " style=\"visibility:hidden;\"";
-            return "<pre><code".concat(slf.renderAttrs(tmpToken), ">").concat(highlighted, "</code><span class=\"title\"").concat(style, ">").concat(info.title, "</span></pre>\n");
-        }
-        return "<pre><code".concat(slf.renderAttrs(tmpToken), ">").concat(highlighted, "</code></pre>\n");
-    }
-    return "<pre><code".concat(slf.renderAttrs(token), ">").concat(highlighted, "</code></pre>\n");
+    return `<pre><code${slf.renderAttrs(tmpToken)}>${highlighted}</code></pre>\n`;
+  }
+  return `<pre><code${slf.renderAttrs(token)}>${highlighted}</code></pre>\n`;
 }
 //# sourceMappingURL=fence-custom.js.map

package/dist/code/highlight.js

@@ -5,21 +5,17 @@
  */
 import hljs from "highlight.js";
 import { InfoString } from "./info-string.js";
-function _debuglog() {
-    var _args = [];
-    for (var _i = 0; _i < arguments.length; _i++) {
-        _args[_i] = arguments[_i];
-    }
-    // if (_debuglog.caller.name !== "") return;
-    // console.log(...args);
+function _debuglog(..._args) {
+  // if (_debuglog.caller.name !== "") return;
+  // console.log(...args);
 }
 /** Get digits of the number. e.g. 1000 => 4 */
 function numDigits(n) {
-    return Math.floor(n).toString().length;
+  return Math.floor(n).toString().length;
 }
 /** Print a decimal nicely */
 function niceDec(n) {
-    return n.toFixed(3);
+  return n.toFixed(3);
 }
 /**
  * Highlight function with line number support
@@ -30,12 +26,12 @@ function niceDec(n) {
  * @returns
  */
 export function highlightWithLineNumber(code, lang, linestart) {
-    try {
-        /** convert if lang is specified + supported by highlight.js */
-        if (lang && hljs.getLanguage(lang)) {
-            /** do conversion */
-            var htmlLines = hljs.highlight(code, { language: lang }).value;
-            /**
+  try {
+    /** convert if lang is specified + supported by highlight.js */
+    if (lang && hljs.getLanguage(lang)) {
+      /** do conversion */
+      let htmlLines = hljs.highlight(code, { language: lang }).value;
+      /**
              * Attach the line number if specified.
              *
              * The given code is rendered in <pre><code>, so each line is terminated by '\n'.
@@ -50,33 +46,33 @@ export function highlightWithLineNumber(code, lang, linestart) {
              * - user-select: none
              * - width: ${numDigits}em
              */
-            if (linestart !== undefined) {
-                var lines = htmlLines.split("\n");
-                var elWidth = numDigits(linestart + lines.length) * 0.8;
-                var elStyle_1 = "display:inline-block;" +
+      if (linestart !== undefined) {
+        const lines = htmlLines.split("\n");
+        const elWidth = numDigits(linestart + lines.length) * 0.8;
+        const elStyle = "display:inline-block;" +
                     "user-select:none;" +
-                    "width: ".concat(niceDec(elWidth), "em;");
-                lines.forEach(function (line, i, lines) {
-                    lines[i] =
+                    `width: ${niceDec(elWidth)}em;`;
+        lines.forEach((line, i, lines) => {
+          lines[i] =
                         "<div class=\"line\">" +
-                            "<span class=\"line-no\" style=\"".concat(elStyle_1, "\">").concat(linestart + i, "</span>").concat(line) +
+                            `<span class="line-no" style="${elStyle}">${linestart + i}</span>${line}` +
                             "</div>";
-                });
-                _debuglog(lines);
-                htmlLines = lines.join("");
-            }
-            return htmlLines;
-        }
-        else {
-            // no language , no highlighting.
-            // If you want line numbers without highlighting, set language to
-            // "nohighlight" or "text"
-            return "";
-        }
+        });
+        _debuglog(lines);
+        htmlLines = lines.join("");
+      }
+      return htmlLines;
     }
-    catch (_) {
-        return "";
+    else {
+      // no language , no highlighting.
+      // If you want line numbers without highlighting, set language to
+      // "nohighlight" or "text"
+      return "";
     }
+  }
+  catch (_) {
+    return "";
+  }
 }
 /**
  * Exported function for markdown-it
@@ -87,9 +83,9 @@ export function highlightWithLineNumber(code, lang, linestart) {
  * @returns
  */
 export function highlighterForMarkdownIt(str, lang, attrs) {
-    _debuglog(lang ? lang : "(lang is empty or undefined)");
-    var info = new InfoString(lang + " " + attrs);
-    _debuglog(info);
-    return highlightWithLineNumber(str, info.lang, info.linestart);
+  _debuglog(lang ? lang : "(lang is empty or undefined)");
+  const info = new InfoString(lang + " " + attrs);
+  _debuglog(info);
+  return highlightWithLineNumber(str, info.lang, info.linestart);
 }
 //# sourceMappingURL=highlight.js.map

package/dist/code/info-string.d.ts

@@ -2,25 +2,25 @@
  * InfoString parses info_string from fenced code block.
  */
 export declare class InfoString {
-    private readonly _lang;
-    private readonly _attrs;
-    private readonly _title;
-    private readonly _linestart;
-    constructor(info: string);
-    get lang(): string;
-    get attrs(): string[];
-    get title(): string;
-    get linestart(): number | undefined;
-    get hasLang(): boolean;
-    /** Parse info_string into an array of strings. All quotes are removed*/
-    static parseInfoString(info: string): string[];
-    /** Parse metadata notation "{filename:line, ...}"" */
-    static parseMetaNotation(text: string): {
-        filename: string;
-        line: number;
-    } | undefined;
-    /** From attributes list, return title metadata */
-    static getTitle(attr: string[]): string;
-    /** From attributes list, return line number if defined */
-    static getLineStart(attr: string[]): number | undefined;
+  private readonly _lang;
+  private readonly _attrs;
+  private readonly _title;
+  private readonly _linestart;
+  constructor(info: string);
+  get lang(): string;
+  get attrs(): string[];
+  get title(): string;
+  get linestart(): number | undefined;
+  get hasLang(): boolean;
+  /** Parse info_string into an array of strings. All quotes are removed*/
+  static parseInfoString(info: string): string[];
+  /** Parse metadata notation "{filename:line, ...}"" */
+  static parseMetaNotation(text: string): {
+    filename: string;
+    line: number;
+  } | undefined;
+  /** From attributes list, return title metadata */
+  static getTitle(attr: string[]): string;
+  /** From attributes list, return line number if defined */
+  static getLineStart(attr: string[]): number | undefined;
 }

package/dist/code/info-string.js

@@ -1,149 +1,129 @@
 /**
  * InfoString parses info_string from fenced code block.
  */
-var InfoString = /** @class */ (function () {
-    function InfoString(info) {
-        if (info.length > 0) {
-            var arr = InfoString.parseInfoString(info);
-            this._lang = arr[0];
-            this._attrs = arr.slice(1);
-            this._title = InfoString.getTitle(this._attrs);
-            this._linestart = InfoString.getLineStart(this._attrs);
-        }
-        else {
-            this._lang = "";
-            this._attrs = [];
-            this._title = "";
-            this._linestart = undefined;
-        }
+export class InfoString {
+  _lang;
+  _attrs;
+  _title;
+  _linestart;
+  constructor(info) {
+    if (info.length > 0) {
+      const arr = InfoString.parseInfoString(info);
+      this._lang = arr[0];
+      this._attrs = arr.slice(1);
+      this._title = InfoString.getTitle(this._attrs);
+      this._linestart = InfoString.getLineStart(this._attrs);
     }
-    Object.defineProperty(InfoString.prototype, "lang", {
-        get: function () {
-            return this._lang;
-        },
-        enumerable: false,
-        configurable: true
-    });
-    Object.defineProperty(InfoString.prototype, "attrs", {
-        get: function () {
-            return this._attrs;
-        },
-        enumerable: false,
-        configurable: true
-    });
-    Object.defineProperty(InfoString.prototype, "title", {
-        get: function () {
-            return this._title;
-        },
-        enumerable: false,
-        configurable: true
-    });
-    Object.defineProperty(InfoString.prototype, "linestart", {
-        get: function () {
-            return this._linestart;
-        },
-        enumerable: false,
-        configurable: true
-    });
-    Object.defineProperty(InfoString.prototype, "hasLang", {
-        get: function () {
-            return this._lang.length > 0;
-        },
-        enumerable: false,
-        configurable: true
-    });
-    /** Parse info_string into an array of strings. All quotes are removed*/
-    InfoString.parseInfoString = function (info) {
-        // There are 4 possible tokens, but it can be reduced to 2 patterns.
-        // arg, "arg quoted", key=value, key="value quoted"
-        // 
-        // This function returns a quote-removed string. 
-        // 
-        // const regex = /([^\s]+=)?(?:"([^"]*)"|'([^']*)'|([^\s]+))/g;
-        //                 ~~~~~~~~     ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
-        //                 key=         "value" 'value' value
-        //
-        // The regex above does not support escape letters. The next regex
-        // is escape char aware. 
-        // 
-        // NOTE: This class is designed to handle escape letters. However, tools 
-        // might decide to unescape info_string before used (e.g. markdown-it). 
-        // In such case, you might need to use double-escaped quotes.
-        // 
-        var dq = "[^\"\\\\]*(?:\\\\.|[^\"\\\\]*)*"; // [^"]*
-        var sq = "[^\'\\\\]*(?:\\\\.|[^\'\\\\]*)*"; // [^']*
-        //          ~~~~~~~~~~   ~~~~~ ~~~~~~~~~~
-        //          char seq   ( escape  char seq )*
-        // 
-        var ptn = "([^\\s]+=)?(?:\"(".concat(dq, ")\"|'(").concat(sq, ")'|([^\\s]+))");
-        //           ~~~~~~~~~~    ~~~~~~~~~ ~~~~~~~~~ ~~~~~~~~~
-        //           key=          "value"   'value'   value
-        var regex = new RegExp(ptn, "g");
-        var result = [];
-        var match;
-        while ((match = regex.exec(info)) !== null) {
-            var text = (match[1] || "") + (match[2] || match[3] || match[4] || "");
-            text = unescape(text).trim();
-            result.push(text);
-        }
-        return result;
-    };
-    /** Parse metadata notation "{filename:line, ...}"" */
-    InfoString.parseMetaNotation = function (text) {
-        var match = text.match(/^\{\s*([^:]+):(\d+)\s*\}$/);
-        if (match) {
-            return {
-                filename: match[1],
-                line: parseInt(match[2], 10),
-            };
-        }
-        return undefined;
-    };
-    /** From attributes list, return title metadata */
-    InfoString.getTitle = function (attr) {
-        var _a;
-        var titleAttr = (_a = attr.find(function (x) { return x.startsWith("title="); })) !== null && _a !== void 0 ? _a : "";
-        if (titleAttr.length > 0) {
-            var match = titleAttr.match(/^title=(.*)$/);
-            if (match) {
-                var value = match[1].trim();
-                if (value.startsWith("\"") && value.endsWith("\"")) {
-                    value = value.slice(1, -1);
-                    value = unescape(value).trim();
-                }
-                return value;
-            }
-            else {
-                throw new Error("Must not fail. Check impl.");
-            }
-        }
-        if (attr.length > 0) {
-            var meta = InfoString.parseMetaNotation(attr[0]);
-            if (meta && meta.filename.length > 0) {
-                return meta.filename;
-            }
-        }
-        return "";
-    };
-    /** From attributes list, return line number if defined */
-    InfoString.getLineStart = function (attr) {
-        var _a;
-        var lineAttr = (_a = attr.find(function (x) { return x.startsWith("linestart="); })) !== null && _a !== void 0 ? _a : "";
-        if (lineAttr.length > 0) {
-            return parseInt(lineAttr.split("=")[1].trim());
-        }
-        if (attr.length > 0) {
-            var meta = InfoString.parseMetaNotation(attr[0]);
-            if (meta && meta.line > 0) {
-                return meta.line;
-            }
+    else {
+      this._lang = "";
+      this._attrs = [];
+      this._title = "";
+      this._linestart = undefined;
+    }
+  }
+  get lang() {
+    return this._lang;
+  }
+  get attrs() {
+    return this._attrs;
+  }
+  get title() {
+    return this._title;
+  }
+  get linestart() {
+    return this._linestart;
+  }
+  get hasLang() {
+    return this._lang.length > 0;
+  }
+  /** Parse info_string into an array of strings. All quotes are removed*/
+  static parseInfoString(info) {
+    // There are 4 possible tokens, but it can be reduced to 2 patterns.
+    // arg, "arg quoted", key=value, key="value quoted"
+    // 
+    // This function returns a quote-removed string. 
+    // 
+    // const regex = /([^\s]+=)?(?:"([^"]*)"|'([^']*)'|([^\s]+))/g;
+    //                 ~~~~~~~~     ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ 
+    //                 key=         "value" 'value' value
+    //
+    // The regex above does not support escape letters. The next regex
+    // is escape char aware. 
+    // 
+    // NOTE: This class is designed to handle escape letters. However, tools 
+    // might decide to unescape info_string before used (e.g. markdown-it). 
+    // In such case, you might need to use double-escaped quotes.
+    // 
+    const dq = "[^\"\\\\]*(?:\\\\.|[^\"\\\\]*)*"; // [^"]*
+    const sq = "[^\'\\\\]*(?:\\\\.|[^\'\\\\]*)*"; // [^']*
+    //          ~~~~~~~~~~   ~~~~~ ~~~~~~~~~~
+    //          char seq   ( escape  char seq )*
+    // 
+    const ptn = `([^\\s]+=)?(?:"(${dq})"|'(${sq})'|([^\\s]+))`;
+    //           ~~~~~~~~~~    ~~~~~~~~~ ~~~~~~~~~ ~~~~~~~~~
+    //           key=          "value"   'value'   value
+    const regex = new RegExp(ptn, "g");
+    const result = [];
+    let match;
+    while ((match = regex.exec(info)) !== null) {
+      let text = (match[1] || "") + (match[2] || match[3] || match[4] || "");
+      text = unescape(text).trim();
+      result.push(text);
+    }
+    return result;
+  }
+  /** Parse metadata notation "{filename:line, ...}"" */
+  static parseMetaNotation(text) {
+    const match = text.match(/^\{\s*([^:]+):(\d+)\s*\}$/);
+    if (match) {
+      return {
+        filename: match[1],
+        line: parseInt(match[2], 10),
+      };
+    }
+    return undefined;
+  }
+  /** From attributes list, return title metadata */
+  static getTitle(attr) {
+    const titleAttr = attr.find(x => x.startsWith("title=")) ?? "";
+    if (titleAttr.length > 0) {
+      const match = titleAttr.match(/^title=(.*)$/);
+      if (match) {
+        let value = match[1].trim();
+        if (value.startsWith("\"") && value.endsWith("\"")) {
+          value = value.slice(1, -1);
+          value = unescape(value).trim();
         }
-        return undefined;
-    };
-    return InfoString;
-}());
-export { InfoString };
+        return value;
+      }
+      else {
+        throw new Error("Must not fail. Check impl.");
+      }
+    }
+    if (attr.length > 0) {
+      const meta = InfoString.parseMetaNotation(attr[0]);
+      if (meta && meta.filename.length > 0) {
+        return meta.filename;
+      }
+    }
+    return "";
+  }
+  /** From attributes list, return line number if defined */
+  static getLineStart(attr) {
+    const lineAttr = attr.find(x => x.startsWith("linestart=")) ?? "";
+    if (lineAttr.length > 0) {
+      return parseInt(lineAttr.split("=")[1].trim());
+    }
+    if (attr.length > 0) {
+      const meta = InfoString.parseMetaNotation(attr[0]);
+      if (meta && meta.line > 0) {
+        return meta.line;
+      }
+    }
+    return undefined;
+  }
+}
 function unescape(text) {
-    return text.replaceAll(/\\\"/g, "\"").replaceAll(/\\\'/g, "'");
+  return text.replaceAll(/\\\"/g, "\"").replaceAll(/\\\'/g, "'");
 }
 //# sourceMappingURL=info-string.js.map

package/dist/index.d.ts

@@ -1,16 +1,42 @@
-export interface Configuration {
-    /**
+import markdownIt, { Options as MarkdownOptions } from "markdown-it";
+import { Options as MathOptions } from "./math/mathjax.js";
+export interface Config {
+  /**
      * Set "true" to display the title (if specified) of the fenced code block.
      * The title is hidden by default, and user must explicitly override the style.
      */
-    showCodeTitleByDefault: boolean;
+  showCodeTitleByDefault: boolean;
+  /**
+     * MarkdownIt options
+     */
+  markdown: Partial<MarkdownOptions>;
+  /**
+     * MathJax options
+     */
+  math: Partial<MathOptions>;
 }
-export type Options = Partial<Configuration>;
-export declare class MarkdownConverter {
-    private readonly _config;
-    private readonly _mj;
-    private readonly _md;
-    constructor(option?: Options);
-    render(text: string): string;
-    mathcss(): string;
+export type Options = Partial<Config>;
+export declare class CMarkdown {
+  private readonly _config;
+  private readonly _mj;
+  private readonly _md;
+  constructor(option?: Options);
+  /**
+     * Install plugins and renderers to the markdown-it instance.
+     *
+     * @param md The instance
+     */
+  setup(md: markdownIt): void;
+  /**
+     * Render html from markdown.
+     *
+     * @param text markdown text
+     * @returns html text
+     */
+  render(text: string): string;
+  /**
+     * Returns the MathJax CSS.
+     * @returns
+     */
+  mathcss(): string;
 }