@glyphjs/runtime 0.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2025 Glyph JS Contributors
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md ADDED
@@ -0,0 +1,52 @@
1
+ # @glyphjs/runtime
2
+
3
+ React rendering engine for Glyph JS IR documents.
4
+
5
+ ## Install
6
+
7
+ ```bash
8
+ pnpm add @glyphjs/runtime react react-dom
9
+ ```
10
+
11
+ ## Usage
12
+
13
+ ```tsx
14
+ import { createGlyphRuntime } from '@glyphjs/runtime';
15
+ import { compile } from '@glyphjs/compiler';
16
+
17
+ const runtime = createGlyphRuntime();
18
+ const { ir } = compile(markdown);
19
+
20
+ function App() {
21
+ return <runtime.Document ir={ir} />;
22
+ }
23
+ ```
24
+
25
+ ### Theming
26
+
27
+ ```tsx
28
+ import { ThemeProvider, darkTheme } from '@glyphjs/runtime';
29
+
30
+ function App() {
31
+ return (
32
+ <ThemeProvider theme={darkTheme}>
33
+ <runtime.Document ir={ir} />
34
+ </ThemeProvider>
35
+ );
36
+ }
37
+ ```
38
+
39
+ ## Key exports
40
+
41
+ - `createGlyphRuntime()` -- create a runtime instance with a `Document` component
42
+ - `GlyphDocument` -- standalone document renderer
43
+ - `BlockRenderer` -- renders individual IR blocks
44
+ - `ThemeProvider` / `useGlyphTheme` -- theme system with light and dark presets
45
+ - `LayoutProvider` / `DocumentLayout` / `DashboardLayout` / `PresentationLayout` -- layout engines
46
+ - `ComponentRegistry` / `PluginRegistry` -- component registration and plugin system
47
+ - `ErrorBoundary` / `FallbackRenderer` -- graceful error handling
48
+ - `RuntimeProvider` / `useRuntime` / `useReferences` -- React context and hooks
49
+
50
+ ## Docs
51
+
52
+ https://github.com/VledicFranco/glyphjs