mathlive - npm Package Compare versions

Comparing version 0.90.9 to 0.90.10

dist/public/commands.d.ts

@@ -1,2 +0,2 @@
-/* 0.90.9 */
import type { Keys } from './types-utils';
+/* 0.90.10 */
import type { Keys } from './types-utils';
 import type { ParseMode, Style } from './core-types';
@@ -3,0 +3,0 @@ import type { InsertOptions, Mathfield, Model } from './mathfield';

dist/public/core-types.d.ts

@@ -1,2 +0,2 @@
-/* 0.90.9 */
export type MathstyleName = 'displaystyle' | 'textstyle' | 'scriptstyle' | 'scriptscriptstyle';
+/* 0.90.10 */
export type MathstyleName = 'displaystyle' | 'textstyle' | 'scriptstyle' | 'scriptscriptstyle';
 export type NormalizedMacroDictionary = Record<string, MacroDefinition>;
@@ -3,0 +3,0 @@ export type ArgumentType = ParseMode | ('bbox' | 'colspec' | 'delim' | 'dimen' | 'number' | 'rest' | 'glue' | 'string' | 'balanced-string' | 'auto');

dist/public/mathfield-element.d.ts

@@ -1,2 +0,2 @@
-/* 0.90.9 */
declare module '@cortex-js/compute-engine';
+/* 0.90.10 */
/// <reference types="public/cortex-compute-engine" />
 import { Selector } from './commands';
@@ -3,0 +3,0 @@ import type { LatexSyntaxError, MacroDictionary, ParseMode, Registers, Style } from './core-types';

dist/public/mathfield.d.ts

@@ -1,2 +0,2 @@
-/* 0.90.9 */
import type { ParseMode, Style } from './core-types';
+/* 0.90.10 */
import type { ParseMode, Style } from './core-types';
 import { Selector } from './commands';
@@ -3,0 +3,0 @@ /**

dist/public/mathlive-ssr.d.ts

@@ -1,9 +0,2 @@
-/* 0.90.9 */
/**
- * Server-side rendering exports.
- *
- * These functions do not require a DOM environment and can
- * be used from a server-side environment.
- *
- */
-declare module '@cortex-js/compute-engine';
+/* 0.90.10 */
/// <reference types="public/cortex-compute-engine" />
 import { Expression } from './mathfield-element';
@@ -10,0 +3,0 @@ import type { LatexSyntaxError, ParseMode } from './core-types';

dist/public/mathlive.d.ts

@@ -1,2 +0,2 @@
-/* 0.90.9 */
/**
+/* 0.90.10 */
/**
  *
@@ -14,4 +14,4 @@ * Use MathLive to render and edit mathematical formulas.
  *
- * @packageDocumentation MathLive SDK Reference 0.90.9
- * @version 0.90.9
+ * @packageDocumentation MathLive SDK Reference 0.90.10
+ * @version 0.90.10
  *
@@ -28,2 +28,4 @@ */
 export * from './mathlive-ssr';
+export * from './virtual-keyboard';
+export * from './virtual-keyboard-types';
 export declare function makeSharedVirtualKeyboard(options?: Partial<VirtualKeyboardOptions>): VirtualKeyboardInterface & EventTarget;
@@ -30,0 +32,0 @@ export declare function renderMathInDocument(options?: AutoRenderOptions): void;

dist/public/options.d.ts

@@ -1,2 +0,2 @@
-/* 0.90.9 */
import type { Mathfield, Range } from './mathfield';
+/* 0.90.10 */
import type { Mathfield, Range } from './mathfield';
 import type { Selector } from './commands';
@@ -3,0 +3,0 @@ import type { ParseMode, MacroDictionary, Registers } from './core-types';

dist/public/types-utils.d.ts

@@ -1,2 +0,2 @@
-/* 0.90.9 */
/**
+/* 0.90.10 */
/**
  * @internal
@@ -3,0 +3,0 @@ */

dist/public/virtual-keyboard-types.d.ts

@@ -1,2 +0,2 @@
-/* 0.90.9 */
import { Selector } from 'mathlive';
+/* 0.90.10 */
import { Selector } from 'mathlive';
 import type { VirtualKeyboardOptions, AlphabeticKeyboardLayout, VirtualKeyboardLayer, VirtualKeyboardLayout, ActionToolbarOptions } from './virtual-keyboard';
@@ -3,0 +3,0 @@ export interface MathfieldProxy {

dist/public/virtual-keyboard.d.ts

@@ -1,2 +0,2 @@
-/* 0.90.9 */
import { Selector } from './commands';
+/* 0.90.10 */
import { Selector } from './commands';
 import { OriginValidator } from './options';
@@ -3,0 +3,0 @@ export type AlphabeticKeyboardLayout = 'auto' | 'qwerty' | 'azerty' | 'qwertz' | 'dvorak' | 'colemak';

package.json

 {
   "name": "mathlive",
-  "version": "0.90.9",
+  "version": "0.90.10",
   "description": "A web component for math input",
@@ -5,0 +5,0 @@ "license": "MIT",

README.md

@@ -8,25 +8,16 @@ <div align="center">
 
-<img src="assets/screenshots/mathlive-demo.png">
-
 [![Maintenance](https://img.shields.io/maintenance/yes/2023.svg)]()
 [![GitHub license](https://img.shields.io/badge/license-MIT-brightgreen.svg)](https://raw.githubusercontent.com/arnog/mathlive/master/LICENSE.txt)
-[![Build Status](https://travis-ci.org/arnog/mathlive.svg?branch=master)](https://travis-ci.org/arnog/mathlive)
 
-- [x] A **Web Component**, easy to integrate in your project, regardless of the
-      framework you use, or even if you just use plain JavaScript
-- [x] Edit **math formulas** with an easy to use interface
-- [x] Beautiful, **TeX-quality** typesetting: over 800 built-in LaTeX commands
-- [x] Designed for **mobile devices** with an extensive set of **virtual
-      keyboards** for math input
-- [x] Compatible with **screen readers**, and includes custom math-to-speech
-      support for improved **accessibility**
-- [x] Output to **LaTeX**, **MathML**, **ASCIIMath** and **MathJSON** (Abstract
-      Syntax Tree) formats
-- [x] And it is easy to **customize** to your needs!
+MathLive is a powerful web component that provides an easy-to-use interface for
+editing math formulas. With over 800 **built-in LaTeX commands**, MathLive
+enables beautiful, **TeX-quality typesetting**. It's designed for **mobile
+devices** with an extensive set of virtual keyboards for math input, and is also
+compatible with screen readers, including custom math-to-speech support for
+improved accessibility. In addition, MathLive outputs to LaTeX, MathML,
+ASCIIMath, and MathJSON formats, making it incredibly versatile. And the best
+part? It's easy to customize to your needs!
 
-Reference documentation and guides at
-[cortexjs.io/mathlive](https://cortexjs.io/mathlive/).
+<img src="assets/screenshots/mathlive-demo.png">
 
-Try it at [cortexjs.io/mathlive/demo/](https://cortexjs.io/mathlive/demo/).
-
 <table align="center" >
@@ -54,7 +45,6 @@ <tr>
 
-## Using MathLive
+## 🚀 Getting Started
 
-**To add a mathfield element to your page** use a `<math-field>` tag.
-
-It works just like a `<textarea>` or `<button>` element. You can manipulate the
+Using MathLive is easy! Simply add a `<math-field>` tag to your page, and it
+works just like a `<textarea>` or `<button>` element. You can manipulate the
 mathfield using methods of the element and listen for events to be notified when
@@ -75,28 +65,11 @@ its internal state changes.
 
-<dl>
-  <dt><a href="https://cortexjs.io/mathlive/guides/getting-started/">Quick Start</a></dt>
-  <dd>Quick introduction to using MathLive in your project</dd>  
-  <dt><a href="https://cortexjs.io/mathlive/guides/interacting">Interact with a mathfield</a></dt>
-  <dd>Receive input and change the value of a mathfield</dd>
-  <dt><a href="https://cortexjs.io/mathlive/guides/customizing">Customize a mathfield</a></dt>
-  <dd>Adapt the behavior and appearance of a mathfield to your needs</dd>
-  <dt><a href="https://cortexjs.io/mathlive/guides/commands">Execute commands</a></dt>
-  <dd>Send editing commands to a mathfield</dd>
-  <dt><a href="https://cortexjs.io/mathlive/guides/macros">Define custom LaTeX macros</a></dt>
-  <dd>Extend the LaTeX commands supported</dd>
-  <dt><a href="https://cortexjs.io/mathlive/guides/shortcuts">Manage inline and keyboard shortcuts</a></dt>
-  <dd>Add or modify editing keyboard shortcuts</dd>
-  <dt><a href="https://cortexjs.io/mathlive/guides/speech">Control speech output</a></dt>
-  <dd>A mathfield can provide speech feedback to interact with it.</dd>
-  <dt><a href="https://cortexjs.io/mathlive/guides/static">Display static math formulas</a></dt>
-  <dd>Display non-editable math formulas in your page</dd>
-  <dt><a href="https://cortexjs.io/mathlive/guides/virtual-keyboards">Define custom virtual keyboards</a></dt>
-  <dd>Customize or create new virtual (on-screen) keyboards</dd>
-  <hr>
-  <dt><a href="https://cortexjs.io/mathlive/guides/integration/">Getting Started</a></dt>
-  <dd>Everything you need to integrate the MathLive library to your project</dd>  
-  <dt><a href="https://cortexjs.io/docs/mathlive">MathLive SDK</a></dt>
-  <dd>Reference documentation of the MathLive API</dd>
-</dl>
+MathLive has an extensive set of documentation to help you get started,
+including guides on interacting with a mathfield, customizing it, executing
+commands, defining custom LaTeX macros, managing inline and keyboard shortcuts,
+controlling speech output, and displaying static math formulas. You can find all
+of these guides on the [MathLive website](https://cortexjs.io/mathlive/).
 
+In addition to the guides, you can also find reference documentation of the
+MathLive API on the [MathLive SDK page](https://cortexjs.io/docs/mathlive).
+
 ## Related Projects
@@ -115,7 +88,7 @@
 
-- Join our [Gitter community](https://gitter.im/cortex-js/community)
+- Join our [Gitter forum](https://cortexjs.io/gitter/)
 - Drop a line to [e-mail]
 
-## License
+## 📃 License
 
 This project is licensed under the [MIT License](LICENSE.txt).

No alert changes

Improved metrics

Total package byte prevSize

4739536

increased by0.06%

Lines of code

83821

increased by0.13%

Worsened metrics

Number of lines in readme file

91

decreased by-22.88%

No dependency changes