@cobapen/markdown 0.4.0 → 0.4.2

package/README.md

@@ -14,4 +14,4 @@ https://cobapen.github.io/markdown
 - fenced code block with filename, line-number support
 - server side syntax highlighting
 - server side math rendering
-
+- complex table rendering

package/{dist → lib}/code/fence-custom.d.ts

@@ -4,10 +4,5 @@ import Token from "markdown-it/lib/token.mjs";
 interface Env {
     showCodeTitleByDefault?: boolean;
 }
-/**
- * Custom fence renderer for markdown-it.
- *
- * see: markdown-it/lib/renderer.mjs
- */
 export declare function fence_custom(tokens: Token[], idx: number, options: Options, env: Env, slf: Renderer): string;
 export {};

package/{dist → lib}/code/fence-custom.js

@@ -1,10 +1,5 @@
 import { escapeHtml, unescapeAll } from "markdown-it/lib/common/utils.mjs";
 import { InfoString } from "./info-string.js";
-/**
- * Custom fence renderer for markdown-it.
- *
- * see: markdown-it/lib/renderer.mjs
- */
 export function fence_custom(tokens, idx, options, env, slf) {
     const token = tokens[idx];
     const info_str = token.info ? unescapeAll(token.info).trim() : "";
@@ -21,9 +16,6 @@ export function fence_custom(tokens, idx, options, env, slf) {
     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() : [];
@@ -34,7 +26,6 @@ export function fence_custom(tokens, idx, options, env, slf) {
             tmpAttrs[i] = tmpAttrs[i].slice();
             tmpAttrs[i][1] += " " + options.langPrefix + langName;
         }
-        // Fake token just to render attributes
         const tmpToken = {
             attrs: tmpAttrs
         };

package/lib/code/highlight.d.ts

@@ -0,0 +1,2 @@
+export declare function highlightWithLineNumber(code: string, lang: string, linestart?: number): string;
+export declare function highlighterForMarkdownIt(str: string, lang: string, attrs: string): string;

package/{dist → lib}/code/highlight.js

@@ -1,51 +1,17 @@
-/**
- * highlight.ts
- * 2023-11-20
- * provides a custom highlighter for MarkdownIt
- */
 import hljs from "highlight.js";
 import { InfoString } from "./info-string.js";
 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;
 }
-/** Print a decimal nicely */
 function niceDec(n) {
     return n.toFixed(3);
 }
-/**
- * Highlight function with line number support
- *
- * @param code
- * @param lang
- * @param linestart
- * @returns
- */
 export function highlightWithLineNumber(code, lang, linestart) {
     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'.
-             * Split the input, wrap them by <div class="line">.
-             * At the beginning of each line, <span class="line-no"> is added.
-             *
-             * default styles are embedded so that the text is readable
-             * even if css was not applied.
-             *
-             * default-styles:
-             * - display: inline-block
-             * - user-select: none
-             * - width: ${numDigits}em
-             */
             if (linestart !== undefined) {
                 const lines = htmlLines.split("\n");
                 const elWidth = numDigits(linestart + lines.length) * 0.8;
@@ -64,9 +30,6 @@ export function highlightWithLineNumber(code, lang, linestart) {
             return htmlLines;
         }
         else {
-            // no language , no highlighting.
-            // If you want line numbers without highlighting, set language to
-            // "nohighlight" or "text"
             return "";
         }
     }
@@ -74,14 +37,6 @@ export function highlightWithLineNumber(code, lang, linestart) {
         return "";
     }
 }
-/**
- * Exported function for markdown-it
- *
- * @param str
- * @param lang
- * @param attrs
- * @returns
- */
 export function highlighterForMarkdownIt(str, lang, attrs) {
     _debuglog(lang ? lang : "(lang is empty or undefined)");
     const info = new InfoString(lang + " " + attrs);

package/{dist → lib}/code/info-string.d.ts

@@ -1,6 +1,3 @@
-/**
- * InfoString parses info_string from fenced code block.
- */
 export declare class InfoString {
     private readonly _lang;
     private readonly _attrs;
@@ -12,15 +9,11 @@ export declare class InfoString {
     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 → lib}/code/info-string.js

@@ -1,6 +1,3 @@
-/**
- * InfoString parses info_string from fenced code block.
- */
 export class InfoString {
     _lang;
     _attrs;
@@ -36,32 +33,10 @@ export class InfoString {
     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 dq = "[^\"\\\\]*(?:\\\\.|[^\"\\\\]*)*";
+        const sq = "[^\'\\\\]*(?:\\\\.|[^\'\\\\]*)*";
         const ptn = `([^\\s]+=)?(?:"(${dq})"|'(${sq})'|([^\\s]+))`;
-        //           ~~~~~~~~~~    ~~~~~~~~~ ~~~~~~~~~ ~~~~~~~~~
-        //           key=          "value"   'value'   value
         const regex = new RegExp(ptn, "g");
         const result = [];
         let match;
@@ -72,7 +47,6 @@ export class InfoString {
         }
         return result;
     }
-    /** Parse metadata notation "{filename:line, ...}"" */
     static parseMetaNotation(text) {
         const match = text.match(/^\{\s*([^:]+):(\d+)\s*\}$/);
         if (match) {
@@ -83,7 +57,6 @@ export class InfoString {
         }
         return undefined;
     }
-    /** From attributes list, return title metadata */
     static getTitle(attr) {
         const titleAttr = attr.find(x => x.startsWith("title=")) ?? "";
         if (titleAttr.length > 0) {
@@ -108,7 +81,6 @@ export class InfoString {
         }
         return "";
     }
-    /** From attributes list, return line number if defined */
     static getLineStart(attr) {
         const lineAttr = attr.find(x => x.startsWith("linestart=")) ?? "";
         if (lineAttr.length > 0) {

package/lib/index.d.ts

@@ -0,0 +1,17 @@
+import markdownIt, { Options as MarkdownOptions } from "markdown-it";
+import { Options as MathOptions } from "./math/mathjax.js";
+export interface Config {
+    showCodeTitleByDefault: boolean;
+    markdown: Partial<MarkdownOptions>;
+    math: Partial<MathOptions>;
+}
+export type Options = Partial<Config>;
+export declare class CMarkdown {
+    private readonly _config;
+    private readonly _mj;
+    private readonly _md;
+    constructor(option?: Options);
+    setup(md: markdownIt): void;
+    render(text: string): string;
+    mathcss(): string;
+}

package/{dist → lib}/index.js

@@ -1,13 +1,9 @@
 import markdownIt from "markdown-it";
 import advTable from "markdown-it-adv-table";
 import anchor from "markdown-it-anchor";
-// @ts-ignore
 import cjkbreaks from "markdown-it-cjk-breaks";
-// @ts-ignore
 import deflist from "markdown-it-deflist";
-// @ts-ignore
 import footnote from "markdown-it-footnote";
-// @ts-ignore
 import toc from "markdown-it-table-of-contents";
 import { fence_custom } from "./code/fence-custom.js";
 import { highlighterForMarkdownIt } from "./code/highlight.js";
@@ -42,11 +38,6 @@ export class CMarkdown {
         this._md = md;
         this.setup(md);
     }
-    /**
-     * Install plugins and renderers to the markdown-it instance.
-     *
-     * @param md The instance
-     */
     setup(md) {
         md.renderer.rules.fence = fence_custom;
         md.use(anchor)
@@ -60,20 +51,10 @@ export class CMarkdown {
             includeLevel: [2, 3],
         });
     }
-    /**
-     * Render html from markdown.
-     *
-     * @param text markdown text
-     * @returns html text
-     */
     render(text) {
-        const env = { ...this._config }; // env object must s
+        const env = { ...this._config };
         return this._md.render(text, env);
     }
-    /**
-     * Returns the MathJax CSS.
-     * @returns
-     */
     mathcss() {
         return this._mj.stylesheet();
     }

package/{dist → lib}/link/replacelink.d.ts

@@ -1,5 +1,5 @@
-import { PluginWithOptions } from "markdown-it";
-import Token from "markdown-it/lib/token.mjs";
+import type { PluginWithOptions } from "markdown-it";
+import type Token from "markdown-it/lib/token.mjs";
 type ReplaceHandler = (link: string, env: any, token: Token) => string;
 interface Options {
     replace: ReplaceHandler;

package/{dist → lib}/math/mathjax.d.ts

@@ -54,14 +54,6 @@ export interface Options {
     tex?: Partial<TexConfig>;
     chtml?: Partial<CHTMLConfig>;
 }
-/**
- * Initialize and encapsulates mathjax instances to generate
- * CommonHTML from TeX input.
- *
- * There are 2 important methods. One converts the input.
- * The other returns a stylesheet document. The stylesheet must be included
- * in your HTML document to render the equation properly.
- */
 export declare class MathjaxEngine {
     option: Options;
     adaptor: LiteAdaptor;
@@ -69,20 +61,7 @@ export declare class MathjaxEngine {
     chtml: CHTML<N, T, D>;
     html: MathDocument<N, T, D>;
     constructor(option?: Partial<Options>);
-    /**
-     * convert TeX input to CHTML.
-     *
-     * @param tex       input string
-     * @param override  parameter to override the defaults, if you wish to
-     * @returns
-     */
     convert(tex: string, override?: Partial<Options>): string;
-    /**
-     * returns adaptive css (stylesheet for the processed equations only),
-     * or the full mathjax css (if configured)
-     *
-     * @returns css content
-     */
     stylesheet(): string;
 }
 export {};

package/{dist → lib}/math/mathjax.js

@@ -1,14 +1,5 @@
-/**
- * mathjax.ts
- *
- * Server-Side Mathjax converter from TeX input to CommonHTML.
- *
- * see official examples for more information
- * https://github.com/mathjax/mathjax-v3
- * https://github.com/mathjax/MathJax-demos-node/blob/master/direct/tex2chtml
-*/
 import { merge } from "lodash-es";
-import { LiteElement } from "mathjax-full/js/adaptors/lite/Element.js"; /* N */
+import { LiteElement } from "mathjax-full/js/adaptors/lite/Element.js";
 import { liteAdaptor } from "mathjax-full/js/adaptors/liteAdaptor.js";
 import { RegisterHTMLHandler } from "mathjax-full/js/handlers/html.js";
 import { AllPackages } from "mathjax-full/js/input/tex/AllPackages.js";
@@ -25,20 +16,12 @@ const defaultOption = {
         packages: AllPackages,
     },
     chtml: {
-        scale: 1.21, // magic # chosen which look nice for me
+        scale: 1.21,
         fontURL: MATHJAX_DEFAULT_FONT_URL,
         adaptiveCSS: true,
         exFactor: 5,
     },
 };
-/**
- * Initialize and encapsulates mathjax instances to generate
- * CommonHTML from TeX input.
- *
- * There are 2 important methods. One converts the input.
- * The other returns a stylesheet document. The stylesheet must be included
- * in your HTML document to render the equation properly.
- */
 export class MathjaxEngine {
     option;
     adaptor;
@@ -75,13 +58,6 @@ export class MathjaxEngine {
             adaptor.append(math.typesetRoot, text);
         }
     }
-    /**
-     * convert TeX input to CHTML.
-     *
-     * @param tex       input string
-     * @param override  parameter to override the defaults, if you wish to
-     * @returns
-     */
     convert(tex, override) {
         const node = this.html.convert(tex, {
             display: !(override?.inline ?? this.option.inline),
@@ -97,12 +73,6 @@ export class MathjaxEngine {
             return "ERROR";
         }
     }
-    /**
-     * returns adaptive css (stylesheet for the processed equations only),
-     * or the full mathjax css (if configured)
-     *
-     * @returns css content
-     */
     stylesheet() {
         return this.adaptor.textContent(this.chtml.styleSheet(this.html));
     }

package/lib/math/mdmath.d.ts

@@ -0,0 +1,3 @@
+import type { PluginSimple } from "markdown-it";
+import { MathjaxEngine } from "./mathjax.js";
+export declare function mdmath(math: MathjaxEngine): PluginSimple;

package/{dist → lib}/math/mdmath.js

@@ -1,17 +1,5 @@
-/**
- * mdmath.ts
- *
- * MarkdownIt extension for math equation processing
- */
 import katex from "katex";
 import { math_block, math_inline } from "./mdparser.js";
-/**
- * Returns a MarkdownIt renderer to render inline/block TeX into HTML.
- * `KaTeX` is used for inline math, `MathJax` is used for block math.
- *
- * @param mathjax   mathjax engine (used for block math processing)
- * @returns
- */
 function getRenderers(mathjax) {
     function renderInlineMath(tex) {
         return katex.renderToString(tex, {
@@ -47,12 +35,6 @@ function getRenderers(mathjax) {
         blockRenderer,
     };
 }
-/**
- * returns a Markdown-It plugin
- *
- * @param math    mathjax Engine to use
- * @returns
- */
 export function mdmath(math) {
     const renderer = getRenderers(math);
     return (md) => {

package/{dist → lib}/math/mdparser.d.ts

@@ -1,8 +1,3 @@
-/**
- * mdparser.ts
- *
- * provides methods to parse MarkdownIt token stream and extract math equations.
- */
 import StateBlock from "markdown-it/lib/rules_block/state_block.mjs";
 import StateInline from "markdown-it/lib/rules_inline/state_inline.mjs";
 export declare function math_inline(state: StateInline, silent: boolean): boolean;

package/{dist → lib}/math/mdparser.js

@@ -1,26 +1,15 @@
-/**
- * mdparser.ts
- *
- * provides methods to parse MarkdownIt token stream and extract math equations.
- */
-/**
- * Tests if potential opening or closing delimieter
- * Assumes that there is a "$" at state.src[pos]
- */
 function isValidDelim(state, pos) {
     const max = state.posMax;
     let can_open = true;
     let can_close = true;
     const prevChar = pos > 0 ? state.src.charCodeAt(pos - 1) : -1;
     const nextChar = pos + 1 <= max ? state.src.charCodeAt(pos + 1) : -1;
-    // Check non-whitespace conditions for opening and closing, and
-    // check that closing delimeter isn't followed by a number
-    if (prevChar === 0x20 /* " " */ ||
-        prevChar === 0x09 /* \t */ ||
-        (nextChar >= 0x30 /* "0" */ && nextChar <= 0x39) /* "9" */) {
+    if (prevChar === 0x20 ||
+        prevChar === 0x09 ||
+        (nextChar >= 0x30 && nextChar <= 0x39)) {
         can_close = false;
     }
-    if (nextChar === 0x20 /* " " */ || nextChar === 0x09 /* \t */) {
+    if (nextChar === 0x20 || nextChar === 0x09) {
         can_open = false;
     }
     return {
@@ -41,26 +30,18 @@ export function math_inline(state, silent) {
         state.pos += 1;
         return true;
     }
-    // First check for and bypass all properly escaped delimieters
-    // This loop will assume that the first leading backtick can not
-    // be the first character in state.src, which is known since
-    // we have found an opening delimieter already.
     const start = state.pos + 1;
     match = start;
     while ((match = state.src.indexOf("$", match)) !== -1) {
-        // Found potential $, look for escapes, pos will point to
-        // first non escape when complete
         pos = match - 1;
         while (state.src[pos] === "\\") {
             pos -= 1;
         }
-        // Even number of escapes, potential closing delimiter found
         if ((match - pos) % 2 == 1) {
             break;
         }
         match += 1;
     }
-    // No closing delimter found.  Consume $ and continue.
     if (match === -1) {
         if (!silent) {
             state.pending += "$";
@@ -68,7 +49,6 @@ export function math_inline(state, silent) {
         state.pos = start;
         return true;
     }
-    // Check if we have empty content, ie: $$.  Do not parse.
     if (match - start === 0) {
         if (!silent) {
             state.pending += "$$";
@@ -76,7 +56,6 @@ export function math_inline(state, silent) {
         state.pos = start + 1;
         return true;
     }
-    // Check for valid closing delimiter
     res = isValidDelim(state, match);
     if (!res.can_close) {
         if (!silent) {
@@ -113,7 +92,6 @@ export function math_block(state, start, end, silent) {
         return true;
     }
     if (firstLine.trim().slice(-2) === "$$") {
-        // Single line expression
         firstLine = firstLine.trim().slice(0, -2);
         found = true;
     }
@@ -125,7 +103,6 @@ export function math_block(state, start, end, silent) {
         pos = state.bMarks[next] + state.tShift[next];
         max = state.eMarks[next];
         if (pos < max && state.tShift[next] < state.blkIndent) {
-            // non-empty line with negative indent should stop the list:
             break;
         }
         if (state.src.slice(pos, max).trim().slice(-2) === "$$") {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cobapen/markdown",
-  "version": "0.4.0",
+  "version": "0.4.2",
   "description": "A markdown converter for cobapen website",
   "keywords": [
     "markdown"
@@ -8,8 +8,8 @@
   "license": "MIT",
   "author": "yamavol",
   "type": "module",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
+  "main": "lib/index.js",
+  "types": "lib/index.d.ts",
   "homepage": "https://github.com/cobapen/markdown#readme",
   "bugs": {
     "url": "https://github.com/cobapen/markdown/issues"
@@ -19,21 +19,20 @@
     "url": "git+https://github.com/cobapen/markdown.git"
   },
   "files": [
-    "dist/**/*.js",
-    "dist/**/*.d.ts"
+    "lib/**/*.js",
+    "lib/**/*.d.ts"
   ],
   "engines": {
     "node": ">=20.11.0 <21 || >=21.2.0"
   },
   "scripts": {
     "build": "tsc",
-    "build:dist": "tsc --build tsconfig.dist.json",
-    "build:doc": "tsc && node docs/build.js",
+    "build:dev": "tsc --build tsconfig.dev.json",
+    "build:doc": "npm run build && node docs/build.js",
     "test": "vitest",
     "coverage": "vitest run --coverage",
     "lint": "eslint src",
-    "lint:fix": "eslint src --fix",
-    "lint:dist": "eslint dist --fix"
+    "lint:fix": "eslint src --fix"
   },
   "dependencies": {
     "highlight.js": "^11.11.1",
@@ -49,7 +48,7 @@
     "mathjax-full": "^3.2.2"
   },
   "devDependencies": {
-    "@stylistic/eslint-plugin": "^4.2.0",
+    "@cobapen/eslint-config": "^0.4.0",
     "@types/katex": "^0.16.7",
     "@types/lodash-es": "^4.17.12",
     "@types/markdown-it": "^14.1.2",
@@ -57,10 +56,8 @@
     "@types/node": "^22.14.1",
     "@vitest/coverage-v8": "^3.1.1",
     "eslint": "^9.24.0",
-    "eslint-plugin-import": "^2.31.0",
     "mustache": "^4.2.0",
     "typescript": "^5.8.3",
-    "typescript-eslint": "^8.29.1",
     "vitest": "^3.1.1"
   }
 }

package/dist/code/highlight.d.ts

@@ -1,18 +0,0 @@
-/**
- * Highlight function with line number support
- *
- * @param code
- * @param lang
- * @param linestart
- * @returns
- */
-export declare function highlightWithLineNumber(code: string, lang: string, linestart?: number): string;
-/**
- * Exported function for markdown-it
- *
- * @param str
- * @param lang
- * @param attrs
- * @returns
- */
-export declare function highlighterForMarkdownIt(str: string, lang: string, attrs: string): string;

package/dist/index.d.ts

@@ -1,42 +0,0 @@
-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;
-    /**
-     * MarkdownIt options
-     */
-    markdown: Partial<MarkdownOptions>;
-    /**
-     * MathJax options
-     */
-    math: Partial<MathOptions>;
-}
-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;
-}

package/dist/math/mdmath.d.ts

@@ -1,14 +0,0 @@
-/**
- * mdmath.ts
- *
- * MarkdownIt extension for math equation processing
- */
-import { PluginSimple } from "markdown-it";
-import { MathjaxEngine } from "./mathjax.js";
-/**
- * returns a Markdown-It plugin
- *
- * @param math    mathjax Engine to use
- * @returns
- */
-export declare function mdmath(math: MathjaxEngine): PluginSimple;