mathlive - npm Package Compare versions

Comparing version 0.50.2 to 0.50.3

CHANGELOG.md

@@ -0,1 +1,7 @@
+## [Unreleased]
+
+### New Features
+
+-   Added a `MathLive.version` string
+
 ## 0.50.2 (May 7, 2020)
@@ -2,0 +8,0 @@

dist/core.d.ts

@@ -39,3 +39,3 @@ /**
  * Typically, those are controlled with explicit commands, such as `\mathbb{}` or
- * `\mathfrak{}`. This type is used with the [[`applyStyle`]] function to change
+ * `\mathfrak{}`. This type is used with the [[`$applyStyle`]] method to change
  * the styling of a range of selected characters.
@@ -42,0 +42,0 @@ *

dist/mathlive.d.ts

@@ -17,3 +17,4 @@ /**
  *
- * @packageDocumentation MathLive SDK Reference
+ * @packageDocumentation MathLive SDK Reference {{GIT_VERSION}}
+ * @version {{GIT_VERSION}}
  *
@@ -27,2 +28,17 @@ */
 /**
+ * The version string for this build of the SDK in the form of:
+ *
+ * `git tag`-`number of comits`-g`abbreviated commit hash`
+ *
+ * The `git tag` uses [semver](https://semver.org/):
+ * - The first number is the **MAJOR** version, incremented for
+ * incompatible API changes
+ * - The second number is the **MINOR** version, incremented for new features
+ * - The third number is the **PATCH** version, incremented for bug fixes
+ *
+ * Current version: `{{GIT_VERSION}}`
+ *
+ */
+export declare const version: string;
+/**
  * Converts a LaTeX string to a string of HTML markup.
@@ -97,3 +113,3 @@ *
  *
- * **See Also:** [[latexToAST|latexToAST()]]
+ * **See Also:** [[astToLatex|astToLatex()]]
  *
@@ -239,14 +255,14 @@ * @param latex A string of valid LaTeX. It does not have to start
         processEnvironments?: boolean;
+        /**
+         * Delimiter pairs that will trigger a render of the content in
+         * display style or inline, respectively.
+         *
+         * **Default**: `{display: [ ['$$', '$$'], ['\\[', '\\]'] ] ], inline: [ ['\\(','\\)'] ] ]}`
+         *
+         */
+        delimiters?: {
+            display: string[][];
+            inline: string[][];
+        };
     };
-    /**
-     * Delimiter pairs that will trigger a render of the content in
-     * display style or inline, respectively.
-     *
-     * **Default**: `{display: [ ['$$', '$$'], ['\\[', '\\]'] ] ], inline: [ ['\\(','\\)'] ] ]}`
-     *
-     */
-    delimiters?: {
-        display: string[][];
-        inline: string[][];
-    };
     /** A function that will convert any LaTeX found to
@@ -269,6 +285,9 @@ * HTML markup. This is only useful to override the default MathLive renderer
  *
- * **Note:** This is a very expensive call, as it needs to parse the entire
+ * **(Caution):**
+ * This is a very expensive call, as it needs to parse the entire
  * DOM tree to determine which elements need to be processed. In most cases
  * this should only be called once per document, once the DOM has been loaded.
+ *
  * To render a specific element, use {@linkcode renderMathInElement | renderMathInElement()}
+ * ---
  *
@@ -293,3 +312,3 @@ * Read {@tutorial mathfield-getting-started | Getting Started}.
  *
- * @param {HTMLElement|string} element An HTML DOM element, or a string containing
+ * @param element An HTML DOM element, or a string containing
  * the ID of an element.
@@ -300,3 +319,3 @@ *
  */
-export declare function renderMathInElement(element: HTMLElement, options?: AutoRenderOptions): void;
+export declare function renderMathInElement(element: string | HTMLElement, options?: AutoRenderOptions): void;
 /**
@@ -303,0 +322,0 @@ *

package.json

 {
     "name": "mathlive",
-    "version": "0.50.2",
+    "version": "0.50.3",
     "description": "Render and edit beautifully typeset math",
@@ -5,0 +5,0 @@ "license": "MIT",

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Lines of code

14515

increased by0.15%

Worsened metrics

Total package byte prevSize

2171211

decreased by-0.24%

Number of package files

58

decreased by-1.69%

No dependency changes