KaTeX website & documentation (#1484)

* website/docs: initial commit * Change secondaryColor * Fix index.css not being copied and included on global stylesheet * Fix stylesheet link [skip ci] * Change documentation link to API(Usage) [skip ci] * Add `Libraries` in usage [skip ci] * Remove documentation from `README.md` and add link to the site [skip ci] * Use KaTeX in the parent directory to build Markdown [skip ci] * Revise function support page. Avoid error msgs. * General edit to function support page
2025-10-10 21:48:41 +00:00 · 2018-07-27 12:19:40 +09:00
parent 83e8eac0a5
commit 8a38035855
28 changed files with 1838 additions and 122 deletions
--- a/website/remarkableKatex.js
+++ b/website/remarkableKatex.js
@@ -0,0 +1,183 @@
+/* MIT License
+
+Copyright (c) 2017 Brad Howes
+
+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.
+*/
+
+/**
+ * Plugin for Remarkable Markdown processor which transforms $..$ and $$..$$ sequences into math HTML using the
+ * Katex package.
+ */
+module.exports = function(md, options) {
+    var katex = require("../");
+
+    function renderKatex(source, displayMode) {
+        return katex.renderToString(source, {displayMode: displayMode, throwOnError: false});
+    }
+
+    /**
+     * Parse '$$' as a block. I don't think this is needed since it is already done in the parseInlineKatex
+     * method. Based off of similar method in remarkable.
+     */
+    function parseBlockKatex(state, startLine, endLine) {
+        var marker, len, params, nextLine, mem,
+            haveEndMarker = false,
+            pos = state.bMarks[startLine] + state.tShift[startLine],
+            max = state.eMarks[startLine];
+        var dollar = 0x24;
+
+        if (pos + 1 > max) { return false; }
+
+        marker = state.src.charCodeAt(pos);
+        if (marker !== dollar) { return false; }
+
+        // scan marker length
+        mem = pos;
+        pos = state.skipChars(pos, marker);
+        len = pos - mem;
+
+        if (len != 2)  { return false; }
+
+        // search end of block
+        nextLine = startLine;
+
+        for (;;) {
+            ++nextLine;
+            if (nextLine >= endLine) {
+
+                // unclosed block should be autoclosed by end of document.
+                // also block seems to be autoclosed by end of parent
+                break;
+            }
+
+            pos = mem = state.bMarks[nextLine] + state.tShift[nextLine];
+            max = state.eMarks[nextLine];
+
+            if (pos < max && state.tShift[nextLine] < state.blkIndent) {
+
+                // non-empty line with negative indent should stop the list:
+                // - ```
+                //  test
+                break;
+            }
+
+            if (state.src.charCodeAt(pos) !== dollar) { continue };
+
+            if (state.tShift[nextLine] - state.blkIndent >= 4) {
+
+                // closing fence should be indented less than 4 spaces
+                continue;
+            }
+
+            pos = state.skipChars(pos, marker);
+
+            // closing code fence must be at least as long as the opening one
+            if (pos - mem < len) { continue; }
+
+            // make sure tail has spaces only
+            pos = state.skipSpaces(pos);
+
+            if (pos < max) { continue; }
+
+            haveEndMarker = true;
+
+            // found!
+            break;
+        }
+
+        // If a fence has heading spaces, they should be removed from its inner block
+        len = state.tShift[startLine];
+
+        state.line = nextLine + (haveEndMarker ? 1 : 0);
+
+        var content = state.getLines(startLine + 1, nextLine, len, true)
+                           .replace(/[ \n]+/g, ' ')
+                           .trim();
+
+        state.tokens.push({
+            type: 'katex',
+            params: params,
+            content: content,
+            lines: [startLine, state.line],
+            level: state.level,
+            block: true
+        });
+
+        return true;
+    }
+
+    /**
+     * Look for '$' or '$$' spans in Markdown text. Based off of the 'fenced' parser in remarkable.
+     */
+    function parseInlineKatex(state, silent) {
+        var dollar = 0x24;
+        var pos = state.pos;
+        var start = pos, max = state.posMax, marker, matchStart, matchEnd ;
+
+        if (state.src.charCodeAt(pos) !== dollar) { return false; }
+        ++pos;
+
+        while (pos < max && state.src.charCodeAt(pos) === dollar) {
+            ++pos;
+        }
+
+        marker = state.src.slice(start, pos);
+        if (marker.length > 2) { return false; }
+
+        matchStart = matchEnd = pos;
+
+        while ((matchStart = state.src.indexOf('$', matchEnd)) !== -1) {
+            matchEnd = matchStart + 1;
+
+            while (matchEnd < max && state.src.charCodeAt(matchEnd) === dollar) {
+                ++matchEnd;
+            }
+
+            if (matchEnd - matchStart == marker.length) {
+                if (!silent) {
+                    var content = state.src.slice(pos, matchStart)
+                                           .replace(/[ \n]+/g, ' ')
+                                           .trim();
+
+                    state.push({
+                        type: 'katex',
+                        content: content,
+                        block: marker.length > 1,
+                        level: state.level
+                    });
+                }
+
+                state.pos = matchEnd;
+                return true;
+            }
+        }
+
+        if (! silent) state.pending += marker;
+        state.pos += marker.length;
+
+        return true;
+    }
+
+    md.inline.ruler.push('katex', parseInlineKatex, options);
+    md.block.ruler.push('katex', parseBlockKatex, options);
+    md.renderer.rules.katex = function(tokens, idx) {
+        return renderKatex(tokens[idx].content, tokens[idx].block);
+    };
+};