@siglum/engine 0.1.0 → 0.1.3
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/README.md +14 -2
- package/package.json +21 -7
package/README.md
CHANGED
|
@@ -1,5 +1,8 @@
|
|
|
1
1
|
# Siglum
|
|
2
2
|
|
|
3
|
+
[](https://www.npmjs.com/package/@siglum/engine)
|
|
4
|
+
[](https://github.com/SiglumProject/siglum-engine/blob/main/LICENSE)
|
|
5
|
+
|
|
3
6
|
A browser-based LaTeX compiler. TeX Live 2025 running in WebAssembly, with lazy bundle loading and on-demand package fetching.
|
|
4
7
|
|
|
5
8
|
On initialization, the engine downloads:
|
|
@@ -12,12 +15,21 @@ The full bundle is ~195MB to deploy, but clients only download what their docume
|
|
|
12
15
|
|
|
13
16
|
**Guides:**
|
|
14
17
|
- [Examples & Playground Tutorial](examples/README.md) — Build a LaTeX editor UI
|
|
15
|
-
- [CTAN Proxy Guide](docs/
|
|
18
|
+
- [CTAN Proxy Guide](docs/ctan-proxy.md) — Self-host the package proxy for production
|
|
19
|
+
- [Building from Source](docs/building.md) — Build WASM engine and bundles
|
|
16
20
|
|
|
17
21
|
## Quick Start (Local Demo)
|
|
18
22
|
|
|
19
23
|
Clone the repo, download the WASM engine and pre-built bundles from [cdn.siglum.org](https://cdn.siglum.org) (or [GitHub Releases](https://github.com/SiglumProject/siglum-engine/releases)), then start the dev server.
|
|
20
24
|
|
|
25
|
+
We use [Bun](https://bun.sh) for development, it's faster than Node.js and runs TypeScript directly. Install it with:
|
|
26
|
+
|
|
27
|
+
```bash
|
|
28
|
+
curl -fsSL https://bun.sh/install | bash
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
Then:
|
|
32
|
+
|
|
21
33
|
```bash
|
|
22
34
|
git clone git@github.com:SiglumProject/siglum-engine.git
|
|
23
35
|
cd siglum-engine
|
|
@@ -301,7 +313,7 @@ bun packages/ctan-proxy.ts
|
|
|
301
313
|
|
|
302
314
|
Packages are cached permanently. The proxy tries TexLive 2025 archives first, then falls back to CTAN mirrors.
|
|
303
315
|
|
|
304
|
-
For configuration and deployment options, see **[docs/
|
|
316
|
+
For configuration and deployment options, see **[docs/ctan-proxy.md](docs/ctan-proxy.md)**.
|
|
305
317
|
|
|
306
318
|
## Browser Requirements
|
|
307
319
|
|
package/package.json
CHANGED
|
@@ -1,16 +1,31 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@siglum/engine",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.3",
|
|
4
4
|
"description": "A browser-based LaTeX compiler. TeX Live 2025 running in WebAssembly, with lazy bundle loading and on-demand package fetching.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "src/index.js",
|
|
7
7
|
"types": "types/index.d.ts",
|
|
8
8
|
"exports": {
|
|
9
|
-
".":
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
"./
|
|
9
|
+
".": {
|
|
10
|
+
"types": "./types/index.d.ts",
|
|
11
|
+
"default": "./src/index.js"
|
|
12
|
+
},
|
|
13
|
+
"./compiler": {
|
|
14
|
+
"types": "./types/compiler.d.ts",
|
|
15
|
+
"default": "./src/compiler.js"
|
|
16
|
+
},
|
|
17
|
+
"./bundles": {
|
|
18
|
+
"types": "./types/bundles.d.ts",
|
|
19
|
+
"default": "./src/bundles.js"
|
|
20
|
+
},
|
|
21
|
+
"./ctan": {
|
|
22
|
+
"types": "./types/ctan.d.ts",
|
|
23
|
+
"default": "./src/ctan.js"
|
|
24
|
+
},
|
|
25
|
+
"./storage": {
|
|
26
|
+
"types": "./types/storage.d.ts",
|
|
27
|
+
"default": "./src/storage.js"
|
|
28
|
+
}
|
|
14
29
|
},
|
|
15
30
|
"files": [
|
|
16
31
|
"src/",
|
|
@@ -18,7 +33,6 @@
|
|
|
18
33
|
],
|
|
19
34
|
"scripts": {
|
|
20
35
|
"dev": "bun serve-local.ts",
|
|
21
|
-
"build:worker": "cp src/worker.js ../webtex/siglum-ui/app/public/worker.js && echo 'Copied worker.js to siglum-ui'",
|
|
22
36
|
"proxy": "cd packages && bun run ctan-proxy.ts",
|
|
23
37
|
"build:types": "tsc",
|
|
24
38
|
"prepublishOnly": "tsc"
|