@formulaxjs/kity-runtime 0.1.0

package/LICENSE

@@ -0,0 +1,35 @@
+# MIT License
+
+Copyright (c) 2024 FormulaX Contributors
+
+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.
+
+---
+
+## Legacy KityFormula Code
+
+Portions of FormulaX, specifically within the `@formulaxjs/kity-runtime` package,
+contain code adapted from [KityFormula](https://github.com/BaiduFE/kityformula)
+by Baidu FEX Team, originally released under the MIT License.
+
+KityFormula-related code in FormulaX is retained under the same MIT License
+and is subject to the copyright notice above.
+
+For details on the original KityFormula project, see:
+https://github.com/BaiduFE/kityformula

package/README.md

@@ -0,0 +1,42 @@
+# @formulaxjs/kity-runtime
+
+Legacy KityFormula runtime adapter for FormulaX.
+
+`@formulaxjs/kity-runtime` packages the compatibility runtime that powers FormulaX's Kity-based editing and rendering flows. It wires legacy runtime code to the modern asset pipeline and provides helpers for mounting the editor in browser applications.
+
+> Status: experimental. Public APIs may change before the first stable release.
+
+## Install
+
+```bash
+pnpm add @formulaxjs/kity-runtime @formulaxjs/kity-assets
+```
+
+## Highlights
+
+- `ensureKityRuntime` for lazy runtime bootstrapping
+- `createKityEditor` and `mountKityEditor` for mounting a Kity editor into the DOM
+- `FormulaXEditor` as a small wrapper around the mounted runtime
+- Legacy compatibility exports used by existing KityFormula-oriented integrations
+
+## Example
+
+```ts
+import { mountKityEditor } from '@formulaxjs/kity-runtime';
+
+const root = document.getElementById('editor');
+
+if (!root) {
+  throw new Error('Missing #editor');
+}
+
+const handle = await mountKityEditor(root, {
+  value: 'x=\\frac{-b\\pm\\sqrt{b^2-4ac}}{2a}',
+});
+
+console.log(handle.getLatex());
+```
+
+## Package role
+
+Use this package when you need the legacy Kity editing experience or compatibility with historical KityFormula behavior. For host-editor integrations, prefer the dedicated adapter packages that already depend on this runtime.