forked from MDViewer-App/mdviewer.app
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathdocs.html
More file actions
1079 lines (976 loc) · 47.7 KB
/
Copy pathdocs.html
File metadata and controls
1079 lines (976 loc) · 47.7 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
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>MDViewer Documentation</title>
<meta name="description" content="Complete documentation for MDViewer — installation, features, keyboard shortcuts, embeddable controls library, and troubleshooting for Windows.">
<link rel="canonical" href="https://mdviewer.app/docs.html">
<meta property="og:type" content="website">
<meta property="og:site_name" content="MDViewer">
<meta property="og:url" content="https://mdviewer.app/docs.html">
<meta property="og:title" content="MDViewer Documentation">
<meta property="og:description" content="Complete documentation for MDViewer — installation, features, keyboard shortcuts, embeddable controls library, and troubleshooting for Windows.">
<meta property="og:image" content="https://mdviewer.app/og-image.png">
<meta name="twitter:card" content="summary_large_image">
<meta name="twitter:title" content="MDViewer Documentation">
<meta name="twitter:description" content="Complete documentation for MDViewer — installation, features, keyboard shortcuts, embeddable controls library, and troubleshooting for Windows.">
<meta name="twitter:image" content="https://mdviewer.app/og-image.png">
<script type="text/javascript">
(function(c,l,a,r,i,t,y){
c[a]=c[a]||function(){(c[a].q=c[a].q||[]).push(arguments)};
t=l.createElement(r);t.async=1;t.src="https://www.clarity.ms/tag/"+i;
y=l.getElementsByTagName(r)[0];y.parentNode.insertBefore(t,y);
})(window, document, "clarity", "script", "utfkjavsme");
</script>
<style>
:root {
--primary-gradient: linear-gradient(135deg, #667eea 0%, #764ba2 100%);
--primary-color: #764ba2;
--pro-color: #667eea;
--text-dark: #1a1a2e;
--text-mid: #444;
--text-light: #666;
--white: #ffffff;
--shadow: rgba(0,0,0,0.08);
--border: #e5e7eb;
--code-bg: #1e1e2e;
--code-text: #cdd6f4;
--sidebar-width: 260px;
--content-max: 820px;
}
* { box-sizing: border-box; margin: 0; padding: 0; }
html { scroll-behavior: smooth; }
body {
font-family: 'Segoe UI', system-ui, -apple-system, sans-serif;
line-height: 1.7;
background: #f4f5f9;
color: var(--text-mid);
min-height: 100vh;
}
/* ── Nav ── */
nav {
background: rgba(255,255,255,0.96);
backdrop-filter: blur(12px);
padding: 0.85rem 0;
position: sticky;
top: 0;
z-index: 200;
border-bottom: 1px solid var(--border);
box-shadow: 0 1px 8px rgba(0,0,0,0.06);
}
.nav-container {
max-width: 1400px;
margin: 0 auto;
padding: 0 24px;
display: flex;
justify-content: space-between;
align-items: center;
gap: 1rem;
}
.nav-brand { font-size: 1.4rem; font-weight: 700; }
.nav-brand a {
background: var(--primary-gradient);
-webkit-background-clip: text;
-webkit-text-fill-color: transparent;
background-clip: text;
text-decoration: none;
}
.nav-links {
display: flex;
gap: 0.25rem;
align-items: center;
flex-wrap: wrap;
}
.nav-links a {
color: var(--text-mid);
text-decoration: none;
font-weight: 500;
font-size: 0.9rem;
padding: 0.4rem 0.85rem;
border-radius: 6px;
transition: background 0.15s, color 0.15s;
}
.nav-links a:hover { background: #f0f0f8; color: var(--primary-color); }
.nav-links a.active { background: rgba(118,75,162,0.1); color: var(--primary-color); font-weight: 600; }
/* ── Page layout ── */
.docs-page {
max-width: 1400px;
margin: 0 auto;
padding: 2rem 24px 4rem;
display: grid;
grid-template-columns: var(--sidebar-width) 1fr;
gap: 2.5rem;
align-items: start;
}
/* ── Sidebar ── */
.docs-sidebar {
position: sticky;
top: calc(56px + 1.5rem);
max-height: calc(100vh - 80px);
overflow-y: auto;
scrollbar-width: thin;
scrollbar-color: #ddd transparent;
}
.docs-sidebar::-webkit-scrollbar { width: 4px; }
.docs-sidebar::-webkit-scrollbar-thumb { background: #ddd; border-radius: 4px; }
.sidebar-inner {
background: white;
border-radius: 12px;
border: 1px solid var(--border);
padding: 1.25rem;
box-shadow: 0 2px 10px var(--shadow);
}
.sidebar-version {
display: flex;
align-items: center;
gap: 0.4rem;
background: linear-gradient(135deg, #f0f2ff 0%, #f5f0ff 100%);
border: 1px solid #d8d0f0;
color: var(--primary-color);
padding: 0.4rem 0.75rem;
border-radius: 8px;
font-size: 0.75rem;
font-weight: 600;
margin-bottom: 1.25rem;
}
.sidebar-version-dot {
width: 6px;
height: 6px;
background: #7defa8;
border-radius: 50%;
flex-shrink: 0;
animation: dot-pulse 2.4s ease-in-out infinite;
}
@keyframes dot-pulse {
0%,100% { opacity:1; transform:scale(1); }
50% { opacity:0.5; transform:scale(0.75); }
}
.sidebar-toc-label {
font-size: 0.7rem;
font-weight: 700;
text-transform: uppercase;
letter-spacing: 0.08em;
color: #aaa;
margin-bottom: 0.6rem;
}
.sidebar-toc {
list-style: none;
}
.sidebar-toc li { margin: 0; }
.sidebar-toc a {
display: flex;
align-items: center;
gap: 0.5rem;
padding: 0.38rem 0.6rem;
border-radius: 6px;
font-size: 0.82rem;
color: var(--text-light);
text-decoration: none;
transition: background 0.15s, color 0.15s;
line-height: 1.3;
}
.sidebar-toc a:hover {
background: #f4f5f9;
color: var(--primary-color);
}
.sidebar-toc a.toc-active {
background: rgba(118,75,162,0.08);
color: var(--primary-color);
font-weight: 600;
}
.sidebar-toc .toc-icon {
font-size: 0.85rem;
flex-shrink: 0;
opacity: 0.7;
}
.sidebar-download {
display: block;
margin-top: 1.25rem;
background: var(--primary-gradient);
color: white;
text-align: center;
padding: 0.65rem 1rem;
border-radius: 8px;
font-size: 0.82rem;
font-weight: 600;
text-decoration: none;
box-shadow: 0 3px 12px rgba(118,75,162,0.3);
transition: box-shadow 0.2s, transform 0.2s;
}
.sidebar-download:hover {
box-shadow: 0 5px 18px rgba(118,75,162,0.4);
transform: translateY(-1px);
}
/* ── Main content ── */
.docs-main { min-width: 0; }
/* Docs hero */
.docs-hero {
background: var(--primary-gradient);
border-radius: 14px;
padding: 2.5rem 2.5rem 2rem;
margin-bottom: 2rem;
color: white;
}
.docs-hero h1 {
font-size: 2rem;
font-weight: 700;
letter-spacing: -0.025em;
margin-bottom: 0.5rem;
}
.docs-hero p {
font-size: 0.95rem;
opacity: 0.88;
max-width: 560px;
line-height: 1.6;
}
.docs-hero-meta {
display: flex;
gap: 1.25rem;
margin-top: 1.25rem;
flex-wrap: wrap;
}
.docs-hero-meta span {
font-size: 0.78rem;
background: rgba(255,255,255,0.15);
border: 1px solid rgba(255,255,255,0.25);
padding: 0.28rem 0.75rem;
border-radius: 100px;
backdrop-filter: blur(6px);
}
/* Sections */
.doc-section {
background: white;
border-radius: 12px;
border: 1px solid var(--border);
padding: 2rem 2.25rem;
margin-bottom: 1.5rem;
box-shadow: 0 2px 8px var(--shadow);
}
.doc-section h2 {
font-size: 1.35rem;
font-weight: 700;
color: var(--text-dark);
margin-bottom: 1.25rem;
padding-bottom: 0.75rem;
border-bottom: 2px solid #f0f0f8;
scroll-margin-top: 80px;
}
.doc-section h3 {
font-size: 1.05rem;
font-weight: 600;
color: var(--text-dark);
margin: 1.75rem 0 0.75rem;
}
.doc-section h3:first-of-type { margin-top: 0.25rem; }
.doc-section h4 {
font-size: 0.9rem;
font-weight: 700;
color: var(--primary-color);
text-transform: uppercase;
letter-spacing: 0.05em;
margin: 0 0 0.6rem;
}
.doc-section p { margin-bottom: 0.75rem; color: var(--text-mid); font-size: 0.93rem; }
.doc-section p:last-child { margin-bottom: 0; }
.doc-section ul, .doc-section ol {
padding-left: 1.5rem;
margin-bottom: 0.75rem;
}
.doc-section li { margin-bottom: 0.3rem; font-size: 0.93rem; color: var(--text-mid); }
.doc-section a { color: var(--primary-color); }
.doc-section strong { color: var(--text-dark); }
/* Cards */
.card {
background: #fafbff;
border: 1px solid #e8eaf6;
border-left: 3px solid var(--pro-color);
border-radius: 8px;
padding: 1.25rem 1.35rem;
margin: 1rem 0;
}
.card.warning {
background: #fffdf0;
border-color: #f0e6b8;
border-left-color: #e6a817;
}
.card.success {
background: #f4fff7;
border-color: #c3eecf;
border-left-color: #28a745;
}
.card.info {
background: #f0f9ff;
border-color: #bae0f8;
border-left-color: #0ea5e9;
}
.card.dark {
background: var(--code-bg);
border-color: rgba(255,255,255,0.06);
border-left-color: var(--pro-color);
}
/* Code */
code {
background: #eef0f8;
color: #5c45a0;
padding: 0.15rem 0.4rem;
border-radius: 4px;
font-family: 'Cascadia Code', 'Consolas', 'Courier New', monospace;
font-size: 0.85em;
}
pre {
background: var(--code-bg);
border-radius: 10px;
padding: 1.25rem 1.5rem;
overflow-x: auto;
margin: 0.75rem 0;
border: 1px solid rgba(255,255,255,0.06);
box-shadow: 0 4px 16px rgba(0,0,0,0.12);
}
pre code {
background: none;
color: var(--code-text);
padding: 0;
font-size: 0.82rem;
line-height: 1.75;
}
/* Tables */
.table-wrap { overflow-x: auto; margin: 0.75rem 0; }
table { width: 100%; border-collapse: collapse; font-size: 0.88rem; }
th {
background: #f4f5f9;
font-weight: 600;
color: var(--text-dark);
padding: 0.65rem 0.9rem;
text-align: left;
border-bottom: 2px solid var(--border);
}
td {
padding: 0.6rem 0.9rem;
border-bottom: 1px solid var(--border);
color: var(--text-mid);
vertical-align: top;
}
tr:last-child td { border-bottom: none; }
tr:hover td { background: #fafbff; }
/* Keyboard shortcut badges */
kbd {
display: inline-block;
background: #f4f5f9;
border: 1px solid #d0d3e0;
border-bottom-width: 2px;
color: var(--text-dark);
padding: 0.1rem 0.5rem;
border-radius: 5px;
font-family: 'Cascadia Code', 'Consolas', monospace;
font-size: 0.78rem;
line-height: 1.6;
white-space: nowrap;
}
/* Inline step numbers */
.steps { counter-reset: steps; padding-left: 0; list-style: none; }
.steps li {
counter-increment: steps;
padding: 0.4rem 0 0.4rem 2.25rem;
position: relative;
}
.steps li::before {
content: counter(steps);
position: absolute;
left: 0;
top: 0.45rem;
width: 1.4rem;
height: 1.4rem;
background: var(--primary-gradient);
color: white;
border-radius: 50%;
font-size: 0.72rem;
font-weight: 700;
display: flex;
align-items: center;
justify-content: center;
line-height: 1;
}
/* Download buttons */
.btn {
display: inline-flex;
align-items: center;
gap: 0.4rem;
padding: 0.55rem 1.1rem;
border-radius: 7px;
font-weight: 600;
font-size: 0.85rem;
text-decoration: none;
transition: all 0.2s;
margin: 0.3rem 0.3rem 0.3rem 0;
}
.btn-primary {
background: var(--primary-gradient);
color: white;
box-shadow: 0 3px 12px rgba(118,75,162,0.3);
}
.btn-primary:hover { box-shadow: 0 5px 16px rgba(118,75,162,0.4); transform: translateY(-1px); }
.btn-secondary {
background: white;
color: var(--primary-color);
border: 1.5px solid var(--primary-color);
}
.btn-secondary:hover { background: rgba(118,75,162,0.06); }
/* Footer */
footer {
background: white;
border-top: 1px solid var(--border);
text-align: center;
padding: 2rem 1rem;
margin-top: 1rem;
}
footer p { color: var(--text-light); font-size: 0.88rem; margin-bottom: 0.4rem; }
footer a { color: var(--text-mid); text-decoration: none; }
footer a:hover { color: var(--primary-color); }
/* Responsive */
@media (max-width: 1024px) {
.docs-page {
grid-template-columns: 220px 1fr;
gap: 1.5rem;
}
}
@media (max-width: 768px) {
.docs-page {
grid-template-columns: 1fr;
padding: 1rem 16px 3rem;
}
.docs-sidebar { display: none; }
.doc-section { padding: 1.5rem 1.25rem; }
.docs-hero { padding: 1.75rem 1.5rem 1.5rem; }
.docs-hero h1 { font-size: 1.6rem; }
}
</style>
</head>
<body>
<nav>
<div class="nav-container">
<div class="nav-brand">
<a href="index.html">MDViewer</a>
</div>
<div class="nav-links">
<a href="index.html">Home</a>
<a href="downloads.html">Download</a>
<a href="docs.html" class="active">Documentation</a>
<a href="pricing.html">Pricing</a>
<a href="blog.html">Blog</a>
</div>
</div>
</nav>
<div class="docs-page">
<!-- Sidebar -->
<aside class="docs-sidebar" aria-label="Documentation navigation">
<div class="sidebar-inner">
<div class="sidebar-version">
<span class="sidebar-version-dot"></span>
v1.7.0 — Latest
</div>
<div class="sidebar-toc-label">On this page</div>
<ul class="sidebar-toc" id="sidebar-toc">
<li><a href="#quick-start" data-section="quick-start"><span class="toc-icon">🚀</span>Quick Start</a></li>
<li><a href="#installation" data-section="installation"><span class="toc-icon">💿</span>Installation</a></li>
<li><a href="#features" data-section="features"><span class="toc-icon">✨</span>Features</a></li>
<li><a href="#navigation" data-section="navigation"><span class="toc-icon">🧭</span>Navigation</a></li>
<li><a href="#editor" data-section="editor"><span class="toc-icon">✏️</span>Built-in Editor</a></li>
<li><a href="#export" data-section="export"><span class="toc-icon">📄</span>Export</a></li>
<li><a href="#enterprise" data-section="enterprise"><span class="toc-icon">🏢</span>Enterprise</a></li>
<li><a href="#controls" data-section="controls"><span class="toc-icon">🔌</span>Embeddable Controls</a></li>
<li><a href="#keyboard" data-section="keyboard"><span class="toc-icon">⌨️</span>Keyboard Shortcuts</a></li>
<li><a href="#troubleshooting" data-section="troubleshooting"><span class="toc-icon">🔧</span>Troubleshooting</a></li>
<li><a href="#advanced" data-section="advanced"><span class="toc-icon">⚙️</span>Advanced Usage</a></li>
<li><a href="#support" data-section="support"><span class="toc-icon">💬</span>Support</a></li>
</ul>
<a href="downloads.html" class="sidebar-download">↓ Download Free</a>
</div>
</aside>
<!-- Main content -->
<main class="docs-main">
<div class="docs-hero">
<h1>MDViewer Documentation</h1>
<p>Complete guide to installation, features, keyboard shortcuts, and enterprise deployment for the professional Markdown viewer for Windows.</p>
<div class="docs-hero-meta">
<span>v1.7.0</span>
<span>Windows 10+</span>
<span>.NET 8</span>
<span>Free to download</span>
</div>
</div>
<!-- Quick Start -->
<section id="quick-start" class="doc-section">
<h2>🚀 Quick Start</h2>
<div class="card success">
<h4>New to MDViewer?</h4>
<ol class="steps">
<li>Download the <strong>Portable ZIP</strong> or run the <strong>Install script</strong> from the <a href="downloads.html">Downloads page</a></li>
<li>Extract and run <code>MDViewer.exe</code>, or let the installer set up file associations</li>
<li>Open any <code>.md</code> file by double-clicking or dragging it onto the window</li>
<li>Use <kbd>Ctrl+E</kbd> to open the built-in editor, <kbd>Ctrl+P</kbd> to export PDF</li>
</ol>
</div>
<h3>After first launch</h3>
<ul>
<li><strong>File associations</strong> — right-click any <code>.md</code> file to see "Open with MDViewer" (MSI install only)</li>
<li><strong>Recent files</strong> — File menu tracks your recently opened documents</li>
<li><strong>Settings persist</strong> — window size, zoom level, and preferences are saved automatically to <code>%LocalAppData%\MDViewer\settings.json</code></li>
<li><strong>Repository detection</strong> — MDViewer walks up the directory tree to find your documentation root automatically</li>
</ul>
<div class="card info">
<h4>WebView2 requirement</h4>
<p>MDViewer uses WebView2 (the Edge rendering engine) for Markdown display. It ships with Windows and is auto-updated via Windows Update. If MDViewer shows a blank window on first launch, see the <a href="#troubleshooting">Troubleshooting</a> section.</p>
</div>
</section>
<!-- Installation -->
<section id="installation" class="doc-section">
<h2>💿 Installation</h2>
<div class="table-wrap">
<table>
<thead>
<tr>
<th>Method</th>
<th>Best for</th>
<th>Requires admin</th>
</tr>
</thead>
<tbody>
<tr>
<td><strong>Portable ZIP</strong></td>
<td>Quick start, no install needed, USB drives</td>
<td>No</td>
</tr>
<tr>
<td><strong>Install script (.bat)</strong></td>
<td>Standard per-machine install with file associations</td>
<td>Yes</td>
</tr>
<tr>
<td><strong>MSI Installer</strong></td>
<td>Enterprise deployment, Group Policy, silent install</td>
<td>Yes</td>
</tr>
</tbody>
</table>
</div>
<h3>Portable ZIP</h3>
<ol class="steps">
<li>Download <code>MDViewer-vX.X.X-Portable.zip</code> from the <a href="downloads.html">Downloads page</a></li>
<li>Extract to any folder (e.g. <code>C:\Tools\MDViewer\</code>)</li>
<li>Run <code>MDViewer.exe</code> — no install or admin rights required</li>
</ol>
<h3>Install script</h3>
<ol class="steps">
<li>Download <code>Install-MDViewer-vX.X.X.bat</code></li>
<li>Right-click → <strong>Run as administrator</strong></li>
<li>The script downloads the MSI, installs it silently, and sets up file associations</li>
</ol>
<h3>Silent / enterprise MSI install</h3>
<pre><code># PowerShell — download and install silently
$repo = "MDViewer-App/mdviewer.app"
$rel = Invoke-RestMethod "https://api.github.com/repos/$repo/releases/latest"
$msi = ($rel.assets | Where-Object { $_.name -like "*Setup.msi" }).browser_download_url
$out = "$env:TEMP\MDViewer-Setup.msi"
Invoke-WebRequest $msi -OutFile $out
Start-Process msiexec.exe -ArgumentList "/i `"$out`" /quiet /norestart" -Wait
Remove-Item $out</code></pre>
<h3>Verifying downloads</h3>
<pre><code># PowerShell SHA256 check
Get-FileHash .\MDViewer-vX.X.X-Portable.zip -Algorithm SHA256
# Compare against checksums-vX.X.X.txt on the release page</code></pre>
</section>
<!-- Features -->
<section id="features" class="doc-section">
<h2>✨ Feature Overview</h2>
<div class="card">
<h4>🧭 Smart Navigation</h4>
<ul>
<li>Auto-detects documentation root by walking up the directory tree looking for <code>.git</code> or markdown clusters</li>
<li>Breadcrumb header and footer added to every rendered page</li>
<li>Related files, subdirectory links, and parent navigation auto-generated</li>
<li>Relative and absolute links resolved correctly; <code>Alt+←</code> goes back through history</li>
</ul>
</div>
<div class="card">
<h4>✏️ Built-in Editor</h4>
<ul>
<li>Open with <kbd>Ctrl+E</kbd> — full text editor window beside the viewer</li>
<li>New, Open, Save, Save As, Find, Replace, Word Wrap</li>
<li>Live preview — save a file and the viewer refreshes automatically</li>
<li>External editor support — configure VS Code, Notepad++, or any editor via Settings</li>
</ul>
</div>
<div class="card">
<h4>📄 Export</h4>
<ul>
<li><strong>PDF</strong> — high-quality via WebView2/Chromium print pipeline, preserves all formatting and images</li>
<li><strong>Word (.docx)</strong> — via Pandoc (auto-downloaded on first use) + PowerShell</li>
<li>Save As dialog with configurable output path</li>
</ul>
</div>
<div class="card">
<h4>🏢 Documentation Hub</h4>
<ul>
<li>Open with <kbd>Ctrl+D</kbd> or Tools → Documentation Hub</li>
<li>Category management with color coding and priority levels</li>
<li>Search across all tracked documents</li>
<li>Dashboard generation for team overviews</li>
</ul>
</div>
<div class="card">
<h4>🔌 Embeddable Controls Library</h4>
<p>New in v1.7.0 — the full engine as a drop-in WinForms control for .NET 8 and .NET Framework 4.8. See the <a href="#controls">Embeddable Controls</a> section below.</p>
</div>
</section>
<!-- Navigation -->
<section id="navigation" class="doc-section">
<h2>🧭 Navigation System</h2>
<h3>Repository detection</h3>
<p>When you open a file, MDViewer walks up the directory tree until it finds a <code>.git</code> folder or a directory with a high density of <code>.md</code> files. That directory becomes the navigation root. The breadcrumb header and footer are then generated relative to that root.</p>
<h3>Link resolution</h3>
<div class="table-wrap">
<table>
<thead><tr><th>Link type</th><th>Example</th><th>Behaviour</th></tr></thead>
<tbody>
<tr><td>Relative</td><td><code>[Guide](../setup/guide.md)</code></td><td>Resolved relative to current file's directory</td></tr>
<tr><td>Absolute</td><td><code>[API](/docs/api.md)</code></td><td>Resolved from navigation root</td></tr>
<tr><td>Directory</td><td><code>[Folder](./subfolder/)</code></td><td>Opens <code>index.md</code> or first <code>.md</code> found</td></tr>
<tr><td>Anchor</td><td><code>[Section](#heading)</code></td><td>Scrolls within the current document</td></tr>
</tbody>
</table>
</div>
<h3>Image resolution</h3>
<p>Images are served via a <code>file://</code> base URL set to the file's directory, so relative paths like <code></code> always resolve correctly regardless of where MDViewer is installed.</p>
<div class="card info">
<h4>Navigation footer elements</h4>
<ul>
<li><strong>📍 Current path</strong> — physical location of the open file</li>
<li><strong>🏠 Root link</strong> — jump back to the documentation root</li>
<li><strong>⬆️ Parent</strong> — go up one directory level</li>
<li><strong>📄 Related files</strong> — other <code>.md</code> files in the same directory</li>
<li><strong>📁 Subdirectories</strong> — folders containing more documentation</li>
</ul>
</div>
</section>
<!-- Editor -->
<section id="editor" class="doc-section">
<h2>✏️ Built-in Editor</h2>
<h3>Opening the editor</h3>
<ul>
<li><kbd>Ctrl+E</kbd> from the viewer</li>
<li>Tools menu → Open Editor</li>
</ul>
<h3>File operations</h3>
<div class="table-wrap">
<table>
<thead><tr><th>Action</th><th>Shortcut</th></tr></thead>
<tbody>
<tr><td>New file</td><td><kbd>Ctrl+N</kbd></td></tr>
<tr><td>Open file</td><td><kbd>Ctrl+O</kbd></td></tr>
<tr><td>Save</td><td><kbd>Ctrl+S</kbd></td></tr>
<tr><td>Save As</td><td><kbd>Ctrl+Shift+S</kbd></td></tr>
<tr><td>Find</td><td><kbd>Ctrl+F</kbd></td></tr>
<tr><td>Replace</td><td><kbd>Ctrl+H</kbd></td></tr>
</tbody>
</table>
</div>
<h3>External editor</h3>
<ol class="steps">
<li>Go to Settings → External Editor</li>
<li>Set the path to your preferred editor (e.g. <code>C:\Program Files\Microsoft VS Code\Code.exe</code>)</li>
<li>Press <kbd>Ctrl+Shift+E</kbd> in the viewer to open the current file in that editor</li>
</ol>
</section>
<!-- Export -->
<section id="export" class="doc-section">
<h2>📄 Export</h2>
<h3>PDF export</h3>
<div class="card">
<h4>How it works</h4>
<p>Triggered by <kbd>Ctrl+P</kbd> or File → Export to PDF. MDViewer uses WebView2's Chromium print pipeline to render a clean PDF — same quality as printing a web page in Edge. A Save As dialog lets you choose the output path.</p>
<ul>
<li>Preserves all markdown styling, images, and tables</li>
<li>Automatic page breaks and margins</li>
<li>Embedded images (relative paths resolved correctly)</li>
</ul>
</div>
<h3>Word export</h3>
<div class="card">
<h4>How it works</h4>
<p>File → Export to Word. MDViewer uses Pandoc (auto-downloaded on first use) invoked via PowerShell to convert the current Markdown source to <code>.docx</code>.</p>
<p><strong>Requirement:</strong> PowerShell execution policy must allow scripts.</p>
<pre><code># If Word export fails, run this in PowerShell (as admin)
Set-ExecutionPolicy RemoteSigned -Scope CurrentUser</code></pre>
</div>
<div class="card warning">
<h4>Common export issues</h4>
<ul>
<li><strong>PDF hangs:</strong> Check disk space and WebView2 permissions; disable antivirus temporarily to test</li>
<li><strong>Word fails:</strong> Check execution policy above; ensure internet access for Pandoc download</li>
<li><strong>Missing images in PDF:</strong> Use relative paths; absolute paths outside the repository root may not resolve</li>
</ul>
</div>
</section>
<!-- Enterprise -->
<section id="enterprise" class="doc-section">
<h2>🏢 Enterprise Features</h2>
<h3>Documentation Hub</h3>
<p>Open via <kbd>Ctrl+D</kbd> or Tools → Documentation Hub. Designed for teams managing large documentation sets across departments.</p>
<div class="card">
<h4>Hub capabilities</h4>
<ul>
<li><strong>Categories</strong> — organize documents by team, project, or type (API Docs, SOPs, User Guides…)</li>
<li><strong>Priority levels</strong> — High / Medium / Low, with visual indicators</li>
<li><strong>Pinned documents</strong> — quick access to frequently used files</li>
<li><strong>Search & filter</strong> — find documents across all categories instantly</li>
<li><strong>Dashboard generation</strong> — produce an overview index page for distribution</li>
</ul>
</div>
<h3>Deployment</h3>
<div class="card">
<h4>Group Policy software installation</h4>
<p>The MSI supports standard Windows Group Policy Software Installation. Deploy to a machine OU and MDViewer will install on next policy refresh with file associations and Start Menu shortcuts.</p>
</div>
<div class="card">
<h4>Registry pre-configuration</h4>
<pre><code>; Pre-configure external editor for all users
[HKEY_LOCAL_MACHINE\SOFTWARE\MDViewer]
"ExternalEditor"="C:\\Program Files\\Microsoft VS Code\\Code.exe"</code></pre>
</div>
<div class="card info">
<h4>Business license</h4>
<p>Enterprise features — shared documentation hubs, network folder support, read-only/kiosk mode, and MSI deployment packaging — are available with a Business license ($79/seat/year). <a href="mailto:support@cnrit.com?subject=MDViewer Business License Inquiry">Contact us</a> for volume pricing and early access.</p>
</div>
</section>
<!-- Controls -->
<section id="controls" class="doc-section">
<h2>🔌 Embeddable Controls Library</h2>
<p><strong>New in v1.7.0.</strong> <code>MarkdownViewer.Controls</code> packages the full MDViewer rendering engine as a WinForms <code>UserControl</code> you can drop into any .NET Windows desktop application — no separate process, no WebSocket server, no infrastructure.</p>
<div class="card info">
<h4>What you get</h4>
<ul>
<li>Full GitHub-flavored Markdown rendering via Markdig + WebView2</li>
<li>Built-in navigation bar — ◀ Back button, breadcrumb label, history stack</li>
<li><kbd>Alt+←</kbd> and <kbd>Ctrl+R</kbd> wired through the Markdown parser (not native browser-back)</li>
<li><code>ExportPdfAsync()</code> and <code>ExportWordAsync()</code> export methods</li>
<li><code>FileNavigated</code> and <code>CanNavigateBackChanged</code> events for host app integration</li>
<li><code>MarkdownViewerOptions</code> for zoom, nav bar visibility, and navigation enhancements</li>
</ul>
</div>
<div class="table-wrap">
<table>
<thead><tr><th>Target</th><th>Rendering</th><th>Navigation</th><th>Word Export</th><th>PDF Export</th></tr></thead>
<tbody>
<tr><td><strong>.NET 8</strong> (net8.0-windows)</td><td>✅</td><td>✅</td><td>✅</td><td>✅</td></tr>
<tr><td><strong>.NET Framework 4.8</strong> (net48)</td><td>✅</td><td>✅</td><td>✅</td><td>— ¹</td></tr>
</tbody>
</table>
</div>
<p style="font-size:0.82rem; color:var(--text-light); margin-top:0.4rem;">¹ PDF export requires .NET 6+. On net48, <code>ExportPdfAsync()</code> throws <code>PlatformNotSupportedException</code> with a clear upgrade message.</p>
<h3>Quick start — C#</h3>
<pre><code>var viewer = new MarkdownViewer.Controls.MarkdownViewerControl();
viewer.Dock = DockStyle.Fill;
this.Controls.Add(viewer);
viewer.LoadFile(@"C:\docs\README.md");</code></pre>
<h3>Quick start — VB.NET</h3>
<pre><code>Dim viewer As New MarkdownViewer.Controls.MarkdownViewerControl()
viewer.Dock = DockStyle.Fill
Me.Controls.Add(viewer)
viewer.LoadFile("C:\docs\README.md")</code></pre>
<h3>Loading inline Markdown</h3>
<pre><code>// Load from string instead of file
viewer.LoadMarkdown("# Hello World\n\nThis is **inline** content.", baseDirectory: @"C:\docs");</code></pre>
<h3>Listening to navigation events</h3>
<pre><code>viewer.FileNavigated += (s, path) => {
titleBar.Text = Path.GetFileName(path);
};
viewer.CanNavigateBackChanged += (s, canGoBack) => {
backButton.Enabled = canGoBack;
};</code></pre>
<div class="card info">
<h4>Available through professional services</h4>
<p><code>MarkdownViewer.Controls</code> is available as part of a professional services engagement. We can help with custom theming, authentication-gated content, search integration, or any other integration your application needs.</p>
<p><strong>Contact:</strong> <a href="mailto:support@cnrit.com">support@cnrit.com</a></p>
</div>
</section>
<!-- Keyboard Shortcuts -->
<section id="keyboard" class="doc-section">
<h2>⌨️ Keyboard Shortcuts</h2>
<h3>Viewer</h3>
<div class="table-wrap">
<table>
<thead><tr><th>Shortcut</th><th>Action</th></tr></thead>
<tbody>
<tr><td><kbd>Ctrl+O</kbd></td><td>Open file picker</td></tr>
<tr><td><kbd>Ctrl+E</kbd></td><td>Open built-in editor</td></tr>
<tr><td><kbd>Ctrl+Shift+E</kbd></td><td>Open in external editor</td></tr>
<tr><td><kbd>Ctrl+P</kbd></td><td>Export to PDF</td></tr>
<tr><td><kbd>F5</kbd> / <kbd>Ctrl+R</kbd></td><td>Reload and re-parse through the Markdown engine</td></tr>
<tr><td><kbd>Alt+←</kbd></td><td>Navigate back to previous document</td></tr>
<tr><td><kbd>Ctrl+D</kbd></td><td>Open Documentation Hub</td></tr>
<tr><td><kbd>Ctrl++</kbd></td><td>Zoom in</td></tr>
<tr><td><kbd>Ctrl+-</kbd></td><td>Zoom out</td></tr>
<tr><td><kbd>Ctrl+0</kbd></td><td>Reset zoom to 100%</td></tr>
<tr><td><kbd>F12</kbd></td><td>Open WebView2 developer tools</td></tr>
</tbody>
</table>
</div>
<h3>Editor window</h3>
<div class="table-wrap">
<table>
<thead><tr><th>Shortcut</th><th>Action</th></tr></thead>
<tbody>
<tr><td><kbd>Ctrl+N</kbd></td><td>New document</td></tr>
<tr><td><kbd>Ctrl+S</kbd></td><td>Save</td></tr>
<tr><td><kbd>Ctrl+Shift+S</kbd></td><td>Save As</td></tr>
<tr><td><kbd>Ctrl+F</kbd></td><td>Find</td></tr>
<tr><td><kbd>Ctrl+H</kbd></td><td>Find and Replace</td></tr>
</tbody>
</table>
</div>
</section>
<!-- Troubleshooting -->
<section id="troubleshooting" class="doc-section">
<h2>🔧 Troubleshooting</h2>
<div class="card warning">
<h4>Blank window on startup — WebView2 missing</h4>
<p><strong>Cause:</strong> WebView2 runtime not installed (unusual — it ships with Windows 10 and later).</p>
<p><strong>Fix:</strong> Run Windows Update, or download the Evergreen Bootstrapper from <a href="https://developer.microsoft.com/en-us/microsoft-edge/webview2/" target="_blank" rel="noopener">Microsoft's WebView2 page</a>.</p>
</div>
<div class="card warning">
<h4>Ctrl+R or Alt+← shows "file not found"</h4>
<p><strong>Cause:</strong> You're on a version older than v1.7.0. WebView2 was intercepting those shortcuts and trying to reload deleted temp files.</p>
<p><strong>Fix:</strong> <a href="downloads.html">Update to v1.7.0</a>. Both shortcuts now route through the Markdown parser correctly.</p>
</div>
<div class="card warning">
<h4>File associations missing — right-click "Open with" not appearing</h4>
<ul>
<li>Re-run the MSI installer with administrator privileges</li>
<li>Or: Right-click a <code>.md</code> file → Properties → Open with → Choose another app → browse to <code>MDViewer.exe</code></li>
</ul>
</div>
<div class="card warning">
<h4>Word export fails</h4>
<ul>
<li>Run in PowerShell (as admin): <code>Set-ExecutionPolicy RemoteSigned -Scope CurrentUser</code></li>
<li>Ensure you have internet access — Pandoc is downloaded on first use</li>
<li>Check that the temp directory (<code>%TEMP%</code>) is writable</li>
</ul>
</div>
<div class="card warning">
<h4>PDF export hangs or produces blank output</h4>
<ul>
<li>Check available disk space in the target directory</li>
<li>Temporarily disable antivirus or security software</li>
<li>Press <kbd>F12</kbd> to open developer tools and check the Console for errors</li>
</ul>
</div>
<h3>Diagnostic mode</h3>
<pre><code># Run built-in diagnostics from the command line
MDViewer.exe --test</code></pre>
<p>This runs checks for .NET runtime availability, Markdig parsing, WebView2 presence, and filesystem access. Output is shown in the console.</p>
<div class="card">
<h4>Settings file location</h4>
<p>If MDViewer is behaving unexpectedly, you can reset it by deleting the settings file:</p>
<pre><code>%LocalAppData%\MDViewer\settings.json</code></pre>
</div>
</section>
<!-- Advanced -->
<section id="advanced" class="doc-section">
<h2>⚙️ Advanced Usage</h2>
<h3>Command-line interface</h3>
<pre><code># Open a specific file
MDViewer.exe "C:\Docs\README.md"
# Run diagnostics
MDViewer.exe --test
# Convert Markdown to PDF (headless)
MDViewer.exe convert input.md pdf output.pdf
# Convert Markdown to HTML
MDViewer.exe convert input.md html output.html
# Show version
MDViewer.exe --version</code></pre>
<h3>Settings file</h3>
<p>User settings are stored at <code>%LocalAppData%\MDViewer\settings.json</code>. You can pre-configure them for deployment:</p>
<pre><code>{
"ZoomFactor": 1.0,
"ExternalEditor": "C:\\Program Files\\Microsoft VS Code\\Code.exe",
"Theme": "GitHub",
"WindowWidth": 1200,
"WindowHeight": 800
}</code></pre>
<h3>Custom CSS themes</h3>
<pre><code>/* Place in %LocalAppData%\MDViewer\Themes\custom.css */
body {
font-family: 'Georgia', serif;
background: #fafaf8;
color: #2c2c2c;
}