commently-editor
v1.2.12
Published
TipTap-based markdown editor as a custom element for textareas
Downloads
2,305
Readme
commently-editor
TipTap-based markdown editor as <commently-textarea-editor>.
Config naming (one scheme)
Use the same logical name in both modes:
| Logical name | Runtime (.env / Vite) | Release (window) |
| --- | --- | --- |
| UPLOAD_API_BASE | VITE_UPLOAD_API_BASE | __UPLOAD_API_BASE__ |
| DISCOVER_API_BASE | VITE_DISCOVER_API_BASE | __DISCOVER_API_BASE__ |
| IMAGE_UPLOAD_JWT | VITE_IMAGE_UPLOAD_JWT | __IMAGE_UPLOAD_JWT__ |
| IMAGE_UPLOAD_JWT_URL | (optional) VITE_IMAGE_UPLOAD_JWT_URL | __IMAGE_UPLOAD_JWT_URL__ |
| IMAGE_UPLOAD_JWT_GET | — | __IMAGE_UPLOAD_JWT_GET__ (() => string \| Promise<string>) |
String values are read with one rule: runtime uses VITE_<NAME>, release uses window['__<NAME>__'].
Runtime (npm run dev / npm run build)
See .env.example. With JWT_SECRET, Vite can set VITE_IMAGE_UPLOAD_JWT for production. In dev, if that is empty, JWT is minted from /__upload_jwt (see vite.config.ts).
Release (dist-npm/commently-editor.js)
Set window['__…__'] before loading the script (same logical names as above). JWT order: __IMAGE_UPLOAD_JWT__ → __IMAGE_UPLOAD_JWT_GET__ → GET __IMAGE_UPLOAD_JWT_URL__ → baked VITE_IMAGE_UPLOAD_JWT if any.
<script>
window.__UPLOAD_API_BASE__ = "https://uploads.example.com";
window.__DISCOVER_API_BASE__ = "https://discover.example.com";
window.__IMAGE_UPLOAD_JWT_URL__ = "https://api.example.com/commently/upload-jwt";
</script>
<script src="node_modules/commently-editor/dist-npm/commently-editor.js"></script>resolveEmbedSrc / resolveImageSrc always come from ./commently (src/main.ts, src/npm.ts).
