-
Notifications
You must be signed in to change notification settings - Fork 9
Expand file tree
/
Copy pathREADME.html
More file actions
740 lines (720 loc) · 39 KB
/
Copy pathREADME.html
File metadata and controls
740 lines (720 loc) · 39 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>
<meta charset="utf-8">
<meta name="generator" content="quarto-1.6.40">
<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">
<title>readme</title>
<style>
code{white-space: pre-wrap;}
span.smallcaps{font-variant: small-caps;}
div.columns{display: flex; gap: min(4vw, 1.5em);}
div.column{flex: auto; overflow-x: auto;}
div.hanging-indent{margin-left: 1.5em; text-indent: -1.5em;}
ul.task-list{list-style: none;}
ul.task-list li input[type="checkbox"] {
width: 0.8em;
margin: 0 0.8em 0.2em -1em; /* quarto-specific, see https://github.com/quarto-dev/quarto-cli/issues/4556 */
vertical-align: middle;
}
/* CSS for syntax highlighting */
pre > code.sourceCode { white-space: pre; position: relative; }
pre > code.sourceCode > span { line-height: 1.25; }
pre > code.sourceCode > span:empty { height: 1.2em; }
.sourceCode { overflow: visible; }
code.sourceCode > span { color: inherit; text-decoration: inherit; }
div.sourceCode { margin: 1em 0; }
pre.sourceCode { margin: 0; }
@media screen {
div.sourceCode { overflow: auto; }
}
@media print {
pre > code.sourceCode { white-space: pre-wrap; }
pre > code.sourceCode > span { display: inline-block; text-indent: -5em; padding-left: 5em; }
}
pre.numberSource code
{ counter-reset: source-line 0; }
pre.numberSource code > span
{ position: relative; left: -4em; counter-increment: source-line; }
pre.numberSource code > span > a:first-child::before
{ content: counter(source-line);
position: relative; left: -1em; text-align: right; vertical-align: baseline;
border: none; display: inline-block;
-webkit-touch-callout: none; -webkit-user-select: none;
-khtml-user-select: none; -moz-user-select: none;
-ms-user-select: none; user-select: none;
padding: 0 4px; width: 4em;
}
pre.numberSource { margin-left: 3em; padding-left: 4px; }
div.sourceCode
{ }
@media screen {
pre > code.sourceCode > span > a:first-child::before { text-decoration: underline; }
}
</style>
<script src="README_files/libs/clipboard/clipboard.min.js"></script>
<script src="README_files/libs/quarto-html/quarto.js"></script>
<script src="README_files/libs/quarto-html/popper.min.js"></script>
<script src="README_files/libs/quarto-html/tippy.umd.min.js"></script>
<script src="README_files/libs/quarto-html/anchor.min.js"></script>
<link href="README_files/libs/quarto-html/tippy.css" rel="stylesheet">
<link href="README_files/libs/quarto-html/quarto-syntax-highlighting-549806ee2085284f45b00abea8c6df48.css" rel="stylesheet" id="quarto-text-highlighting-styles">
<script src="README_files/libs/bootstrap/bootstrap.min.js"></script>
<link href="README_files/libs/bootstrap/bootstrap-icons.css" rel="stylesheet">
<link href="README_files/libs/bootstrap/bootstrap-973236bd072d72a04ee9cd82dcc9cb29.min.css" rel="stylesheet" append-hash="true" id="quarto-bootstrap" data-mode="light">
</head>
<body class="fullcontent">
<div id="quarto-content" class="page-columns page-rows-contents page-layout-article">
<main class="content" id="quarto-document-content">
<p><a href="README.md">English</a> | <a href="README_zh.md">简体中文</a> | <a href="README_zh_TW.md">繁體中文</a></p>
<section id="markitdown-gui-wrapper" class="level1">
<h1>MarkItDown GUI Wrapper</h1>
<p>A desktop GUI for <code>MarkItDown</code>, built with <code>PySide6</code> and official Qt Quick Controls/QML. It focuses on fast multi-file conversion to Markdown with a modern, native-styled desktop interface.</p>
<div class="quarto-figure quarto-figure-center">
<figure class="figure">
<p><img src="image.png" class="img-fluid figure-img"></p>
<figcaption>Current UI screenshot</figcaption>
</figure>
</div>
<p>More screenshots:</p>
<table class="caption-top table">
<colgroup>
<col style="width: 35%">
<col style="width: 64%">
</colgroup>
<thead>
<tr class="header">
<th>Settings</th>
<th>Help and updates</th>
</tr>
</thead>
<tbody>
<tr class="odd">
<td><img src="docs/screenshots/settings.png" class="img-fluid" alt="Settings screenshot"></td>
<td><img src="docs/screenshots/help.png" class="img-fluid" alt="Help and updates screenshot"></td>
</tr>
</tbody>
</table>
<section id="features" class="level2">
<h2 class="anchored" data-anchor-id="features">Features</h2>
<ul>
<li>Queue-based file workflow with drag and drop.</li>
<li>Paste website URLs and convert article content to Markdown with the hosted Defuddle API.</li>
<li>Serial conversion with start, pause/resume, cancel, and progress feedback.</li>
<li>Results view with per-file selection and Markdown preview.</li>
<li>Preview modes: rendered Markdown view and raw Markdown view.</li>
<li>Save modes: export as one combined file or separate files.</li>
<li>Quick actions: copy Markdown, save output, retry failed conversions, back to queue, start over.</li>
<li>Optional OCR for scanned PDFs and image files, with selectable <code>Azure + Tesseract</code>, <code>GLM-OCR</code>, and generic <code>HTTP OCR</code> providers.</li>
<li>Opt-in fast local conversion for clear digital PDFs using <code>pdf-inspector</code>; scanned, mixed, uncertain, and encoding-problem PDFs continue through the existing conversion and OCR path.</li>
<li>Settings for output folder, save mode, source-folder saves, OCR, and theme mode (light/dark/system).</li>
<li>Help view with project links, OCR references, conversion references, and keyboard shortcuts.</li>
</ul>
</section>
<section id="installation" class="level2">
<h2 class="anchored" data-anchor-id="installation">Installation</h2>
<p>Download prebuilt binaries from <a href="https://github.com/imadreamerboy/markitdown-gui/releases">Releases</a>, or run from source.</p>
<section id="release-assets" class="level3">
<h3 class="anchored" data-anchor-id="release-assets">Release assets</h3>
<ul>
<li>Windows: use <code>MarkItDown-Windows-Setup-<version>.exe</code> for the normal installer, or <code>MarkItDown-Windows-<version>.zip</code> for a portable folder.</li>
<li>Linux: use <code>MarkItDown-Linux-<version>.AppImage</code> for a single-file app, or <code>MarkItDown-Linux-<version>.zip</code> for a portable folder.</li>
<li>macOS: use <code>MarkItDown-macOS-<version>.dmg</code> and drag the app into Applications.</li>
</ul>
</section>
<section id="updating" class="level3">
<h3 class="anchored" data-anchor-id="updating">Updating</h3>
<ul>
<li>Packaged desktop builds are updated from <a href="https://github.com/imadreamerboy/markitdown-gui/releases">Releases</a>. The in-app update check reads the latest GitHub release, shows a short release-note summary, and prefers the asset for the current operating system. Help shows the selected asset, size, checksum availability, action, and restart behaviour before install.</li>
<li>Windows and Linux packaged builds can start an in-app install when the preferred asset is a <code>.zip</code>: the app shows install progress, downloads the archive, verifies SHA256 when release metadata is available, prepares an external helper, closes, replaces the app folder, restarts, and rolls back if replacement fails. The helper records the last update result and rollback backup path in Help -> Diagnostics on the next launch, with a direct action to open the backup folder when it still exists. macOS packaged builds download, verify, and open the <code>.dmg</code> for manual drag-to-Applications installation.</li>
<li>The Windows installer and Linux AppImage are additional first-install download options; the in-app self-update path intentionally keeps using the portable <code>.zip</code> asset.</li>
<li>Release builds publish a <code>markitdown-release-manifest.json</code> with platform, size, and SHA256 metadata for each package.</li>
<li>Source checkouts can update in place from the Help view with <code>Run source update</code>, or from a terminal:</li>
</ul>
<div class="sourceCode" id="cb1"><pre class="sourceCode sh code-with-copy"><code class="sourceCode bash"><span id="cb1-1"><a href="#cb1-1" aria-hidden="true" tabindex="-1"></a><span class="ex">python</span> <span class="at">-m</span> markitdowngui.utils.source_updater</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
<p>The source updater first checks that the checkout has no tracked local changes, then runs <code>git pull --ff-only</code> and reinstalls the app in editable mode with <code>uv</code> when available or <code>pip</code> otherwise. The Help view shows a restart action after it finishes.</p>
</section>
<section id="support-bundles" class="level3">
<h3 class="anchored" data-anchor-id="support-bundles">Support bundles</h3>
<p>The Help view shows a compact readiness summary for OCR, packaged updates, source updates, update checks, and logs. Copy diagnostics includes that readiness summary with home paths and obvious secret values redacted. The view can also export a support bundle for issue reports with a diagnostics report, sanitised settings, and capped recent log tails; raw recent file paths, output paths, and obvious secret values are excluded or redacted.</p>
</section>
<section id="settings-profiles" class="level3">
<h3 class="anchored" data-anchor-id="settings-profiles">Settings profiles</h3>
<p>The Settings view can export or import a portable JSON profile for OCR, update, conversion, theme, language, and save-mode preferences. Profiles include provider endpoints and environment variable names, but exclude recent files, recent outputs, window state, and default output folders.</p>
</section>
<section id="prerequisites" class="level3">
<h3 class="anchored" data-anchor-id="prerequisites">Prerequisites</h3>
<ul>
<li>Python <code>3.10+</code></li>
<li><code>uv</code> (recommended)</li>
</ul>
<p>Install dependencies:</p>
<div class="sourceCode" id="cb2"><pre class="sourceCode sh code-with-copy"><code class="sourceCode bash"><span id="cb2-1"><a href="#cb2-1" aria-hidden="true" tabindex="-1"></a><span class="ex">uv</span> sync</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
<p>Alternative:</p>
<div class="sourceCode" id="cb3"><pre class="sourceCode sh code-with-copy"><code class="sourceCode bash"><span id="cb3-1"><a href="#cb3-1" aria-hidden="true" tabindex="-1"></a><span class="ex">pip</span> install <span class="at">-e</span> .<span class="pp">[</span><span class="ss">dev</span><span class="pp">]</span></span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
</section>
<section id="ocr-notes" class="level3">
<h3 class="anchored" data-anchor-id="ocr-notes">OCR Notes</h3>
<ul>
<li>OCR is optional and disabled by default.</li>
<li><strong>Fast PDF conversion</strong> is optional and disabled by default. Enable it from the conversion controls for text-based PDFs where speed matters. It is bypassed when preserving PDF images, and it falls back to the established PDF pipeline when the document is scanned, mixed, uncertain, or has encoding issues.</li>
<li><code>Azure + Tesseract</code> uses Azure Document Intelligence first when configured, then Tesseract as its local fallback.</li>
<li><code>GLM-OCR</code> is available as a separate OCR provider for PDFs and images. It can fall back to another configured provider if selected in Settings.</li>
<li><code>HTTP OCR</code> is a generic integration point for local or self-hosted OCR servers. The app sends a multipart <code>POST</code> with a <code>file</code> part, optional <code>model</code> field, and optional <code>Authorization: Bearer ...</code> header read from the configured environment variable. JSON responses can use <code>markdown</code>, <code>text</code>, <code>result</code>, <code>content</code>, or <code>output</code>; plain text responses are used directly.</li>
<li>Preserved PDF images keep using the existing image-preservation pipeline. With <code>Azure + Tesseract</code>, OCR runs inside that helper. With <code>GLM-OCR</code> or <code>HTTP OCR</code>, the app preserves images first and appends OCR text from the selected provider.</li>
<li>Settings shows one-click OCR presets for common local stacks, plus provider-specific setup actions for opening docs or copying safe setup snippets. <strong>Validate OCR</strong> checks the required fields before a batch starts, and <strong>Test connection</strong> checks live provider connectivity without uploading user documents.</li>
<li>GLM-OCR offers three modes in Settings:
<ul>
<li><code>Official API</code>: easiest zero-setup path, reads <code>ZHIPU_API_KEY</code> or <code>GLMOCR_API_KEY</code> from the environment.</li>
<li><code>Ollama</code>: easiest local path. The GUI calls Ollama’s native <code>/api/generate</code> endpoint directly, with defaults <code>127.0.0.1:11434</code> and <code>glm-ocr:latest</code>.</li>
<li><code>SDK Server (vLLM / SGLang)</code>: stronger self-hosted path. Point the app at an existing <code>/glmocr/parse</code> endpoint. Default: <code>http://127.0.0.1:5002/glmocr/parse</code>.</li>
</ul></li>
<li>The packaged desktop app does not bundle the GLM-OCR self-hosted runtime stack (<code>torch</code>, <code>transformers</code>, <code>vLLM</code>, <code>SGLang</code>, and related server/runtime pieces stay external).</li>
<li>The project depends on <code>glmocr==0.1.4</code> for client-side Official API and SDK Server connectivity. Ollama is called directly over HTTP.</li>
<li>Local OCR requires a system <code>tesseract</code> binary. Install it from the <a href="https://github.com/tesseract-ocr/tesseract">official Tesseract project</a>. If it is not on your <code>PATH</code>, set the executable path in Settings.</li>
<li>Azure OCR requires an Azure Document Intelligence endpoint in Settings.</li>
<li>Azure Document Intelligence pricing includes <a href="https://azure.microsoft.com/en-us/products/ai-foundry/tools/document-intelligence#Pricing">500 free pages per month</a> at the time of writing.</li>
<li>For API-key auth, set <code>AZURE_OCR_API_KEY</code>.</li>
<li>If <code>AZURE_OCR_API_KEY</code> is not set, Azure OCR falls back to Azure identity credentials supported by <code>DefaultAzureCredential</code>.</li>
<li>GLM-OCR project reference: <a href="https://github.com/zai-org/GLM-OCR">zai-org/GLM-OCR</a></li>
</ul>
</section>
<section id="recommended-local-hosting" class="level3">
<h3 class="anchored" data-anchor-id="recommended-local-hosting">Recommended Local Hosting</h3>
<p>For normal local use, the easiest path is Ollama. For stronger self-hosted deployments, use the GLM-OCR SDK Server with vLLM or SGLang.</p>
</section>
<section id="ollama" class="level3">
<h3 class="anchored" data-anchor-id="ollama">Ollama</h3>
<ol type="1">
<li>Install Ollama.</li>
<li>Pull the model:</li>
</ol>
<div class="sourceCode" id="cb4"><pre class="sourceCode sh code-with-copy"><code class="sourceCode bash"><span id="cb4-1"><a href="#cb4-1" aria-hidden="true" tabindex="-1"></a><span class="ex">ollama</span> pull glm-ocr:latest</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
<ol start="3" type="1">
<li>Start the service if it is not already running:</li>
</ol>
<div class="sourceCode" id="cb5"><pre class="sourceCode sh code-with-copy"><code class="sourceCode bash"><span id="cb5-1"><a href="#cb5-1" aria-hidden="true" tabindex="-1"></a><span class="ex">ollama</span> serve</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
<ol start="4" type="1">
<li>In this app, choose <code>GLM-OCR</code> -> <code>Ollama</code>.</li>
<li>Keep the defaults unless you changed them:
<ul>
<li>host: <code>127.0.0.1</code></li>
<li>port: <code>11434</code></li>
<li>model: <code>glm-ocr:latest</code></li>
</ul></li>
</ol>
</section>
<section id="sdk-server" class="level3">
<h3 class="anchored" data-anchor-id="sdk-server">SDK Server</h3>
<ol type="1">
<li>Create a separate Python environment for GLM-OCR.</li>
<li>Install <code>glmocr[selfhosted,server]</code> in that environment.</li>
<li>Start a local <code>vLLM</code> or <code>SGLang</code> backend for <code>zai-org/GLM-OCR</code>.</li>
<li>Start the SDK server:</li>
</ol>
<div class="sourceCode" id="cb6"><pre class="sourceCode sh code-with-copy"><code class="sourceCode bash"><span id="cb6-1"><a href="#cb6-1" aria-hidden="true" tabindex="-1"></a><span class="ex">python</span> <span class="at">-m</span> glmocr.server <span class="at">--config</span> config.yaml</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
<ol start="5" type="1">
<li>In this app, choose <code>GLM-OCR</code> -> <code>SDK Server (vLLM / SGLang)</code> and keep <code>http://127.0.0.1:5002/glmocr/parse</code>.</li>
</ol>
<p>Minimal server-side <code>config.yaml</code>:</p>
<div class="sourceCode" id="cb7"><pre class="sourceCode yaml code-with-copy"><code class="sourceCode yaml"><span id="cb7-1"><a href="#cb7-1" aria-hidden="true" tabindex="-1"></a><span class="fu">pipeline</span><span class="kw">:</span></span>
<span id="cb7-2"><a href="#cb7-2" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">maas</span><span class="kw">:</span></span>
<span id="cb7-3"><a href="#cb7-3" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">enabled</span><span class="kw">:</span><span class="at"> </span><span class="ch">false</span></span>
<span id="cb7-4"><a href="#cb7-4" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">ocr_api</span><span class="kw">:</span></span>
<span id="cb7-5"><a href="#cb7-5" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">api_host</span><span class="kw">:</span><span class="at"> </span><span class="fl">127.0.0.1</span></span>
<span id="cb7-6"><a href="#cb7-6" aria-hidden="true" tabindex="-1"></a><span class="at"> </span><span class="fu">api_port</span><span class="kw">:</span><span class="at"> </span><span class="dv">8080</span></span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
<p>The official GLM-OCR docs show the full Ollama, <code>vLLM</code>, and <code>SGLang</code> setup commands:</p>
<ul>
<li><a href="https://github.com/zai-org/GLM-OCR/blob/main/examples/ollama-deploy/README.md">Official Ollama deployment guide</a></li>
<li><a href="https://github.com/zai-org/GLM-OCR/blob/main/examples/self-host/README.md">Self-hosted SDK Server + Client Guide</a></li>
<li><a href="https://github.com/zai-org/GLM-OCR">GLM-OCR README</a></li>
</ul>
</section>
<section id="website-url-notes" class="level3">
<h3 class="anchored" data-anchor-id="website-url-notes">Website URL Notes</h3>
<ul>
<li>Website conversion uses the hosted <a href="https://defuddle.md/">Defuddle</a> API.</li>
<li>The app sends the pasted <code>http://</code> or <code>https://</code> URL to <code>https://defuddle.md/<url></code> and stores the returned Markdown in the normal results view.</li>
<li>Defuddle responses typically include YAML frontmatter metadata at the top when available.</li>
<li>According to the <a href="https://defuddle.md/terms">Defuddle Terms</a>, unauthenticated requests are limited to <code>1,000</code> requests per month per IP address as of March 14, 2026.</li>
<li>Because requests are sent directly from the desktop app, that free-tier limit applies to the user’s own network IP.</li>
<li>Website conversion requires an internet connection and depends on the external Defuddle service being available.</li>
</ul>
</section>
</section>
<section id="run-the-app" class="level2">
<h2 class="anchored" data-anchor-id="run-the-app">Run the App</h2>
<div class="sourceCode" id="cb8"><pre class="sourceCode sh code-with-copy"><code class="sourceCode bash"><span id="cb8-1"><a href="#cb8-1" aria-hidden="true" tabindex="-1"></a><span class="ex">uv</span> run python <span class="at">-m</span> markitdowngui.main</span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
</section>
<section id="keyboard-shortcuts" class="level2">
<h2 class="anchored" data-anchor-id="keyboard-shortcuts">Keyboard Shortcuts</h2>
<ul>
<li><code>Ctrl+O</code>: Open files</li>
<li><code>Ctrl+S</code>: Save output</li>
<li><code>Ctrl+C</code>: Copy output</li>
<li><code>Ctrl+R</code>: Retry failed conversions</li>
<li><code>Ctrl+P</code>: Pause/resume</li>
<li><code>Ctrl+B</code>: Start conversion</li>
<li><code>Ctrl+L</code>: Clear queue</li>
<li><code>Ctrl+K</code>: Show shortcuts</li>
<li><code>Esc</code>: Cancel conversion</li>
</ul>
</section>
<section id="build-a-standalone-executable" class="level2">
<h2 class="anchored" data-anchor-id="build-a-standalone-executable">Build a Standalone Executable</h2>
<div class="sourceCode" id="cb9"><pre class="sourceCode sh code-with-copy"><code class="sourceCode bash"><span id="cb9-1"><a href="#cb9-1" aria-hidden="true" tabindex="-1"></a><span class="ex">uv</span> sync <span class="at">--extra</span> dev <span class="at">--locked</span></span>
<span id="cb9-2"><a href="#cb9-2" aria-hidden="true" tabindex="-1"></a><span class="ex">pyinstaller</span> MarkItDown.spec <span class="at">--clean</span> <span class="at">--noconfirm</span></span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
<p>The default spec builds an <code>onedir</code> app in <code>dist/MarkItDown/</code>. On macOS it also emits <code>dist/MarkItDown.app</code>. Release workflows package Windows and Linux builds into platform-specific <code>.zip</code> artifacts, add a Windows Inno Setup <code>.exe</code> installer, add a Linux <code>.AppImage</code>, and package macOS builds into a drag-to-Applications <code>.dmg</code> from the <code>.app</code> bundle. The macOS bundle is signed with <code>MACOS_CODESIGN_IDENTITY</code> when configured, otherwise it uses ad-hoc signing. Each release also includes <code>markitdown-release-manifest.json</code> for update metadata and checksums. That build intentionally excludes the GLM-OCR self-hosted runtime stack; local hosting stays external to the GUI.</p>
</section>
<section id="license" class="level2">
<h2 class="anchored" data-anchor-id="license">License</h2>
<p>MarkItDown GUI is licensed under the <strong>MIT License</strong>. Commercial use, private use, modification, redistribution, sublicensing, and sale are permitted under that licence, subject to preserving the copyright and licence notice.</p>
<p>Third-party components keep their own licences. The app uses <code>PySide6</code>/Qt under Qt’s LGPL/commercial licensing model; see <a href="THIRD_PARTY_NOTICES.md"><code>THIRD_PARTY_NOTICES.md</code></a> for the runtime and dependency notices that apply to source and packaged builds.</p>
</section>
<section id="contributing" class="level2">
<h2 class="anchored" data-anchor-id="contributing">Contributing</h2>
<ol type="1">
<li>Fork the repository and create a branch.</li>
<li>Install dev dependencies:</li>
</ol>
<div class="sourceCode" id="cb10"><pre class="sourceCode sh code-with-copy"><code class="sourceCode bash"><span id="cb10-1"><a href="#cb10-1" aria-hidden="true" tabindex="-1"></a><span class="ex">uv</span> pip install <span class="at">-e</span> .<span class="pp">[</span><span class="ss">dev</span><span class="pp">]</span></span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
<ol start="3" type="1">
<li>Make your changes.</li>
<li>Run tests:</li>
</ol>
<div class="sourceCode" id="cb11"><pre class="sourceCode sh code-with-copy"><code class="sourceCode bash"><span id="cb11-1"><a href="#cb11-1" aria-hidden="true" tabindex="-1"></a><span class="ex">uv</span> sync <span class="at">--extra</span> test <span class="at">--locked</span></span>
<span id="cb11-2"><a href="#cb11-2" aria-hidden="true" tabindex="-1"></a><span class="ex">uv</span> run pytest <span class="at">-q</span></span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
<ol start="5" type="1">
<li>Open a pull request with a clear summary.</li>
</ol>
</section>
<section id="credits" class="level2">
<h2 class="anchored" data-anchor-id="credits">Credits</h2>
<ul>
<li>MarkItDown (<a href="https://opensource.org/licenses/MIT">MIT License</a>)</li>
<li>PySide6 (<a href="https://www.gnu.org/licenses/lgpl-3.0.html">LGPLv3 License</a>)</li>
<li>Qt Quick Controls (<a href="https://doc.qt.io/qt-6/qtquickcontrols-index.html">Qt documentation</a>)</li>
<li>Lucide icons (<a href="https://lucide.dev/license">ISC License</a>)</li>
</ul>
</section>
</section>
</main>
<!-- /main column -->
<script id="quarto-html-after-body" type="application/javascript">
window.document.addEventListener("DOMContentLoaded", function (event) {
const toggleBodyColorMode = (bsSheetEl) => {
const mode = bsSheetEl.getAttribute("data-mode");
const bodyEl = window.document.querySelector("body");
if (mode === "dark") {
bodyEl.classList.add("quarto-dark");
bodyEl.classList.remove("quarto-light");
} else {
bodyEl.classList.add("quarto-light");
bodyEl.classList.remove("quarto-dark");
}
}
const toggleBodyColorPrimary = () => {
const bsSheetEl = window.document.querySelector("link#quarto-bootstrap");
if (bsSheetEl) {
toggleBodyColorMode(bsSheetEl);
}
}
toggleBodyColorPrimary();
const icon = "";
const anchorJS = new window.AnchorJS();
anchorJS.options = {
placement: 'right',
icon: icon
};
anchorJS.add('.anchored');
const isCodeAnnotation = (el) => {
for (const clz of el.classList) {
if (clz.startsWith('code-annotation-')) {
return true;
}
}
return false;
}
const onCopySuccess = function(e) {
// button target
const button = e.trigger;
// don't keep focus
button.blur();
// flash "checked"
button.classList.add('code-copy-button-checked');
var currentTitle = button.getAttribute("title");
button.setAttribute("title", "Copied!");
let tooltip;
if (window.bootstrap) {
button.setAttribute("data-bs-toggle", "tooltip");
button.setAttribute("data-bs-placement", "left");
button.setAttribute("data-bs-title", "Copied!");
tooltip = new bootstrap.Tooltip(button,
{ trigger: "manual",
customClass: "code-copy-button-tooltip",
offset: [0, -8]});
tooltip.show();
}
setTimeout(function() {
if (tooltip) {
tooltip.hide();
button.removeAttribute("data-bs-title");
button.removeAttribute("data-bs-toggle");
button.removeAttribute("data-bs-placement");
}
button.setAttribute("title", currentTitle);
button.classList.remove('code-copy-button-checked');
}, 1000);
// clear code selection
e.clearSelection();
}
const getTextToCopy = function(trigger) {
const codeEl = trigger.previousElementSibling.cloneNode(true);
for (const childEl of codeEl.children) {
if (isCodeAnnotation(childEl)) {
childEl.remove();
}
}
return codeEl.innerText;
}
const clipboard = new window.ClipboardJS('.code-copy-button:not([data-in-quarto-modal])', {
text: getTextToCopy
});
clipboard.on('success', onCopySuccess);
if (window.document.getElementById('quarto-embedded-source-code-modal')) {
const clipboardModal = new window.ClipboardJS('.code-copy-button[data-in-quarto-modal]', {
text: getTextToCopy,
container: window.document.getElementById('quarto-embedded-source-code-modal')
});
clipboardModal.on('success', onCopySuccess);
}
var localhostRegex = new RegExp(/^(?:http|https):\/\/localhost\:?[0-9]*\//);
var mailtoRegex = new RegExp(/^mailto:/);
var filterRegex = new RegExp('/' + window.location.host + '/');
var isInternal = (href) => {
return filterRegex.test(href) || localhostRegex.test(href) || mailtoRegex.test(href);
}
// Inspect non-navigation links and adorn them if external
var links = window.document.querySelectorAll('a[href]:not(.nav-link):not(.navbar-brand):not(.toc-action):not(.sidebar-link):not(.sidebar-item-toggle):not(.pagination-link):not(.no-external):not([aria-hidden]):not(.dropdown-item):not(.quarto-navigation-tool):not(.about-link)');
for (var i=0; i<links.length; i++) {
const link = links[i];
if (!isInternal(link.href)) {
// undo the damage that might have been done by quarto-nav.js in the case of
// links that we want to consider external
if (link.dataset.originalHref !== undefined) {
link.href = link.dataset.originalHref;
}
}
}
function tippyHover(el, contentFn, onTriggerFn, onUntriggerFn) {
const config = {
allowHTML: true,
maxWidth: 500,
delay: 100,
arrow: false,
appendTo: function(el) {
return el.parentElement;
},
interactive: true,
interactiveBorder: 10,
theme: 'quarto',
placement: 'bottom-start',
};
if (contentFn) {
config.content = contentFn;
}
if (onTriggerFn) {
config.onTrigger = onTriggerFn;
}
if (onUntriggerFn) {
config.onUntrigger = onUntriggerFn;
}
window.tippy(el, config);
}
const noterefs = window.document.querySelectorAll('a[role="doc-noteref"]');
for (var i=0; i<noterefs.length; i++) {
const ref = noterefs[i];
tippyHover(ref, function() {
// use id or data attribute instead here
let href = ref.getAttribute('data-footnote-href') || ref.getAttribute('href');
try { href = new URL(href).hash; } catch {}
const id = href.replace(/^#\/?/, "");
const note = window.document.getElementById(id);
if (note) {
return note.innerHTML;
} else {
return "";
}
});
}
const xrefs = window.document.querySelectorAll('a.quarto-xref');
const processXRef = (id, note) => {
// Strip column container classes
const stripColumnClz = (el) => {
el.classList.remove("page-full", "page-columns");
if (el.children) {
for (const child of el.children) {
stripColumnClz(child);
}
}
}
stripColumnClz(note)
if (id === null || id.startsWith('sec-')) {
// Special case sections, only their first couple elements
const container = document.createElement("div");
if (note.children && note.children.length > 2) {
container.appendChild(note.children[0].cloneNode(true));
for (let i = 1; i < note.children.length; i++) {
const child = note.children[i];
if (child.tagName === "P" && child.innerText === "") {
continue;
} else {
container.appendChild(child.cloneNode(true));
break;
}
}
if (window.Quarto?.typesetMath) {
window.Quarto.typesetMath(container);
}
return container.innerHTML
} else {
if (window.Quarto?.typesetMath) {
window.Quarto.typesetMath(note);
}
return note.innerHTML;
}
} else {
// Remove any anchor links if they are present
const anchorLink = note.querySelector('a.anchorjs-link');
if (anchorLink) {
anchorLink.remove();
}
if (window.Quarto?.typesetMath) {
window.Quarto.typesetMath(note);
}
if (note.classList.contains("callout")) {
return note.outerHTML;
} else {
return note.innerHTML;
}
}
}
for (var i=0; i<xrefs.length; i++) {
const xref = xrefs[i];
tippyHover(xref, undefined, function(instance) {
instance.disable();
let url = xref.getAttribute('href');
let hash = undefined;
if (url.startsWith('#')) {
hash = url;
} else {
try { hash = new URL(url).hash; } catch {}
}
if (hash) {
const id = hash.replace(/^#\/?/, "");
const note = window.document.getElementById(id);
if (note !== null) {
try {
const html = processXRef(id, note.cloneNode(true));
instance.setContent(html);
} finally {
instance.enable();
instance.show();
}
} else {
// See if we can fetch this
fetch(url.split('#')[0])
.then(res => res.text())
.then(html => {
const parser = new DOMParser();
const htmlDoc = parser.parseFromString(html, "text/html");
const note = htmlDoc.getElementById(id);
if (note !== null) {
const html = processXRef(id, note);
instance.setContent(html);
}
}).finally(() => {
instance.enable();
instance.show();
});
}
} else {
// See if we can fetch a full url (with no hash to target)
// This is a special case and we should probably do some content thinning / targeting
fetch(url)
.then(res => res.text())
.then(html => {
const parser = new DOMParser();
const htmlDoc = parser.parseFromString(html, "text/html");
const note = htmlDoc.querySelector('main.content');
if (note !== null) {
// This should only happen for chapter cross references
// (since there is no id in the URL)
// remove the first header
if (note.children.length > 0 && note.children[0].tagName === "HEADER") {
note.children[0].remove();
}
const html = processXRef(null, note);
instance.setContent(html);
}
}).finally(() => {
instance.enable();
instance.show();
});
}
}, function(instance) {
});
}
let selectedAnnoteEl;
const selectorForAnnotation = ( cell, annotation) => {
let cellAttr = 'data-code-cell="' + cell + '"';
let lineAttr = 'data-code-annotation="' + annotation + '"';
const selector = 'span[' + cellAttr + '][' + lineAttr + ']';
return selector;
}
const selectCodeLines = (annoteEl) => {
const doc = window.document;
const targetCell = annoteEl.getAttribute("data-target-cell");
const targetAnnotation = annoteEl.getAttribute("data-target-annotation");
const annoteSpan = window.document.querySelector(selectorForAnnotation(targetCell, targetAnnotation));
const lines = annoteSpan.getAttribute("data-code-lines").split(",");
const lineIds = lines.map((line) => {
return targetCell + "-" + line;
})
let top = null;
let height = null;
let parent = null;
if (lineIds.length > 0) {
//compute the position of the single el (top and bottom and make a div)
const el = window.document.getElementById(lineIds[0]);
top = el.offsetTop;
height = el.offsetHeight;
parent = el.parentElement.parentElement;
if (lineIds.length > 1) {
const lastEl = window.document.getElementById(lineIds[lineIds.length - 1]);
const bottom = lastEl.offsetTop + lastEl.offsetHeight;
height = bottom - top;
}
if (top !== null && height !== null && parent !== null) {
// cook up a div (if necessary) and position it
let div = window.document.getElementById("code-annotation-line-highlight");
if (div === null) {
div = window.document.createElement("div");
div.setAttribute("id", "code-annotation-line-highlight");
div.style.position = 'absolute';
parent.appendChild(div);
}
div.style.top = top - 2 + "px";
div.style.height = height + 4 + "px";
div.style.left = 0;
let gutterDiv = window.document.getElementById("code-annotation-line-highlight-gutter");
if (gutterDiv === null) {
gutterDiv = window.document.createElement("div");
gutterDiv.setAttribute("id", "code-annotation-line-highlight-gutter");
gutterDiv.style.position = 'absolute';
const codeCell = window.document.getElementById(targetCell);
const gutter = codeCell.querySelector('.code-annotation-gutter');
gutter.appendChild(gutterDiv);
}
gutterDiv.style.top = top - 2 + "px";
gutterDiv.style.height = height + 4 + "px";
}
selectedAnnoteEl = annoteEl;
}
};
const unselectCodeLines = () => {
const elementsIds = ["code-annotation-line-highlight", "code-annotation-line-highlight-gutter"];
elementsIds.forEach((elId) => {
const div = window.document.getElementById(elId);
if (div) {
div.remove();
}
});
selectedAnnoteEl = undefined;
};
// Handle positioning of the toggle
window.addEventListener(
"resize",
throttle(() => {
elRect = undefined;
if (selectedAnnoteEl) {
selectCodeLines(selectedAnnoteEl);
}
}, 10)
);
function throttle(fn, ms) {
let throttle = false;
let timer;
return (...args) => {
if(!throttle) { // first call gets through
fn.apply(this, args);
throttle = true;
} else { // all the others get throttled
if(timer) clearTimeout(timer); // cancel #2
timer = setTimeout(() => {
fn.apply(this, args);
timer = throttle = false;
}, ms);
}
};
}
// Attach click handler to the DT
const annoteDls = window.document.querySelectorAll('dt[data-target-cell]');
for (const annoteDlNode of annoteDls) {
annoteDlNode.addEventListener('click', (event) => {
const clickedEl = event.target;
if (clickedEl !== selectedAnnoteEl) {
unselectCodeLines();
const activeEl = window.document.querySelector('dt[data-target-cell].code-annotation-active');
if (activeEl) {
activeEl.classList.remove('code-annotation-active');
}
selectCodeLines(clickedEl);
clickedEl.classList.add('code-annotation-active');
} else {
// Unselect the line
unselectCodeLines();
clickedEl.classList.remove('code-annotation-active');
}
});
}
const findCites = (el) => {
const parentEl = el.parentElement;
if (parentEl) {
const cites = parentEl.dataset.cites;
if (cites) {
return {
el,
cites: cites.split(' ')
};
} else {
return findCites(el.parentElement)
}
} else {
return undefined;
}
};
var bibliorefs = window.document.querySelectorAll('a[role="doc-biblioref"]');
for (var i=0; i<bibliorefs.length; i++) {
const ref = bibliorefs[i];
const citeInfo = findCites(ref);
if (citeInfo) {
tippyHover(citeInfo.el, function() {
var popup = window.document.createElement('div');
citeInfo.cites.forEach(function(cite) {
var citeDiv = window.document.createElement('div');
citeDiv.classList.add('hanging-indent');
citeDiv.classList.add('csl-entry');
var biblioDiv = window.document.getElementById('ref-' + cite);
if (biblioDiv) {
citeDiv.innerHTML = biblioDiv.innerHTML;
}
popup.appendChild(citeDiv);
});
return popup.innerHTML;
});
}
}
});
</script>
</div> <!-- /content -->
</body></html>