@aiquants/markdown 12.2.0 → 12.2.1
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 +2 -3
- package/dist/converter/NOTICES.md +1 -1
- package/dist/converter.wasm +0 -0
- package/package.json +7 -7
package/README.md
CHANGED
|
@@ -220,7 +220,7 @@ const { htmlContent, headings } = await converter.convert(
|
|
|
220
220
|
- **Paths**: `filePath` is read as the service reads it. Give a local document's path relative to any absolute `workspaceRoot`: the converter writes workspace-relative document paths (`data-asset-src`, `data-doc-path`), the same as the service with the real root. The deny rules apply as written; symbolic links are not resolved, since there is no file system, so the service stays the authority when the host serves a target.
|
|
221
221
|
- **One conversion at a time**, in call order. One aborted before it starts never runs; one aborted while it runs rejects at once with the signal's reason and its answer is dropped, since a WebAssembly call cannot be interrupted. `timeoutMs` counts from the moment the converter is loaded; past it the converter stops its worker, rejects with `MarkdownConversionTimeoutError` and starts a new worker for the next conversion.
|
|
222
222
|
- **Errors**: `MarkdownResourceExhaustedError` past a size limit (the same class `./server` exports; the browser applies the service's default limits, an 8 MiB source and a 32 MiB HTML, lowered by `maxHtmlBytes`), `MarkdownConversionTimeoutError`, and `MarkdownConversionError` with `code`: `invalid_argument` for a refused request, `internal` when the converter failed on the document, `unavailable` when the converter could not load or was disposed (every later call fails the same way; create a new converter to retry). `dispose()` stops the worker.
|
|
223
|
-
- **Assets**: `converter.wasm` is about 9
|
|
223
|
+
- **Assets**: `converter.wasm` is about 6.9 MiB (gzip 1.8 MiB, brotli 1.3 MiB); serve it as `application/wasm`, so it compiles while it downloads, and compressed. The first conversion starts the worker, compiles the module and starts Go (about 0.4 s in Chromium); a 700-line document then converts in about 35 ms, the worker's round trip included. The worker is one self-contained script that starts with the `wasm_exec.js` of the Go toolchain that built the module, under its BSD license; `dist/converter/NOTICES.md` lists the licenses of everything linked into the module.
|
|
224
224
|
- **Content Security Policy**: a page that sets `script-src` needs `'wasm-unsafe-eval'` in it, and `worker-src 'self'` (or a `script-src` that covers the worker) for the same-origin worker.
|
|
225
225
|
- **Building from source** needs the Go toolchain on PATH: `pnpm run build` compiles `cmd/markdown-wasm` of `packages/go/markdown-api` and bundles the worker with the same toolchain's `wasm_exec.js` (`pnpm run build:converter` alone).
|
|
226
226
|
|
|
@@ -1249,8 +1249,7 @@ The markup is the one the `ZennMessageNode` / `ZennDetailsNode` components rende
|
|
|
1249
1249
|
|
|
1250
1250
|
### Notes
|
|
1251
1251
|
|
|
1252
|
-
-
|
|
1253
|
-
- Double-tilde strikethrough (`~~text~~`) remains available via GFM.
|
|
1252
|
+
- Strikethrough takes exactly two tildes (`~~text~~`), which is narrower than GFM: a single tilde stays text, so `~text~` is reserved for subscript. A run of three or more tildes does not strike.
|
|
1254
1253
|
|
|
1255
1254
|
## License
|
|
1256
1255
|
|
package/dist/converter.wasm
CHANGED
|
Binary file
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@aiquants/markdown",
|
|
3
|
-
"version": "12.2.
|
|
3
|
+
"version": "12.2.1",
|
|
4
4
|
"description": "Markdown renderer for React with advanced features",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "./dist/index.cjs",
|
|
@@ -171,12 +171,12 @@
|
|
|
171
171
|
"access": "public"
|
|
172
172
|
},
|
|
173
173
|
"optionalDependencies": {
|
|
174
|
-
"@aiquants/markdown-linux-x64": "12.2.
|
|
175
|
-
"@aiquants/markdown-linux-arm64": "12.2.
|
|
176
|
-
"@aiquants/markdown-darwin-x64": "12.2.
|
|
177
|
-
"@aiquants/markdown-darwin-arm64": "12.2.
|
|
178
|
-
"@aiquants/markdown-win32-x64": "12.2.
|
|
179
|
-
"@aiquants/markdown-win32-arm64": "12.2.
|
|
174
|
+
"@aiquants/markdown-linux-x64": "12.2.1",
|
|
175
|
+
"@aiquants/markdown-linux-arm64": "12.2.1",
|
|
176
|
+
"@aiquants/markdown-darwin-x64": "12.2.1",
|
|
177
|
+
"@aiquants/markdown-darwin-arm64": "12.2.1",
|
|
178
|
+
"@aiquants/markdown-win32-x64": "12.2.1",
|
|
179
|
+
"@aiquants/markdown-win32-arm64": "12.2.1"
|
|
180
180
|
},
|
|
181
181
|
"scripts": {
|
|
182
182
|
"build": "pnpm -w run workspace:build \"$PNPM_SCRIPT_SRC_DIR\"",
|