{{ message }}
Repository navigation
docs: explain how to put marktext on PATH on every platform - #5459
Merged
Merged
Conversation
CLI.md documented the `marktext` command but only showed how to reach it on macOS, so Windows users are left to invent their own shim. The obvious one -- a symlink, hard link or copy of `marktext.exe` in a PATH directory -- dies before MarkText starts, because Chromium resolves `icudtl.dat` next to the executable path it was launched from and Windows reports the link's own path. All the user sees is Chromium's `Invalid file descriptor to ICU data received.` Document the working route for each platform and name that failure mode explicitly, so the error is searchable. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
1 task done
Contributor
|
Website preview ready: https://pr-5459-marktext-website.ransixi.workers.dev Built from |
Contributor
|
Build artifacts for PR #5459: Run: https://github.com/marktext/marktext/actions/runs/35447926589 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #5119
Problem
CLI.mddocuments themarktextcommand line but only shows how to reach the binary onmacOS. Windows users are left to invent their own shim, and the obvious one — a symlink, a
hard link, or a copy of
marktext.exedropped into a directory already onPATH— abortsbefore any MarkText code runs:
Chromium resolves
icudtl.datand the other bundled resources relative to the executable pathit was launched from, and on Windows that is the link's own path, not the target's. The
directory the link lives in has no
icudtl.dat, so startup fails aCHECKand the processdies with
STATUS_BREAKPOINT(0x80000003).Verification
Probed every launch route on a
windows-latestrunner against the published 0.19.1 x64artifacts, using
marktext --version(handled insrc/main/cli/index.tsand printed longbefore any window is created, so it is a GUI-free probe — if Chromium starts, the version
prints):
marktext.exefrom the extracted release zipMarkText: v0.19.1marktext.exefrom a default NSIS installMarkText: v0.19.1extras/marktext) shimMarkText: v0.19.1.cmdwrapper onPATHMarkText: v0.19.1marktext.exe0x80000003marktext.exe0x80000003marktext.exe0x80000003So every supported install route is fine and only a hand-made link or copy breaks — which is
exactly what the documentation gap pushes people towards.
Change
Per-platform instructions for making
marktextavailable in a shell, plus an explicit warningabout the link/copy trap on Windows that quotes the ICU error so it is searchable. The Linux
note points out the contrast:
/usr/bin/marktextfrom the.deb/.rpmpackages is asymlink into
/opt/marktextand works, because the kernel resolves it before the processstarts.
Documentation only — no code changes. The crash happens inside Chromium's startup, before any
MarkText JavaScript runs, so it cannot be caught or reported by the app itself.
🤖 Generated with Claude Code