forked from James-Yu/LaTeX-Workshop
-
Notifications
You must be signed in to change notification settings - Fork 0
/
package.json
1448 lines (1448 loc) · 53.2 KB
/
package.json
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
{
"name": "latex-workshop",
"displayName": "LaTeX Workshop",
"description": "Boost LaTeX typesetting efficiency with preview, compile, autocomplete, colorize, and more.",
"icon": "icons/icon.png",
"version": "7.3.0",
"publisher": "James-Yu",
"license": "MIT",
"homepage": "https://github.com/James-Yu/LaTeX-Workshop",
"repository": {
"type": "git",
"url": "https://github.com/James-Yu/LaTeX-Workshop.git"
},
"engines": {
"vscode": "^1.34.0"
},
"categories": [
"Programming Languages",
"Snippets"
],
"keywords": [
"latex",
"tex",
"compile",
"preview",
"hint"
],
"activationEvents": [
"onLanguage:tex",
"onLanguage:latex",
"onLanguage:doctex",
"onLanguage:pdf",
"onCommand:latex-workshop.build",
"onCommand:latex-workshop.recipes",
"onCommand:latex-workshop.view",
"onCommand:latex-workshop.tab",
"onCommand:latex-workshop.synctex",
"onCommand:latex-workshop.clean",
"onCommand:latex-workshop.citation",
"onCommand:latex-workshop.wordcount",
"onCommand:latex-workshop.compilerlog",
"onCommand:latex-workshop.log",
"onCommand:latex-workshop.actions"
],
"main": "./out/src/main.js",
"contributes": {
"languages": [
{
"id": "tex",
"aliases": [
"TeX",
"tex"
],
"extensions": [
".sty",
".cls",
".bbx",
".cbx"
],
"configuration": "./syntax/syntax.json"
},
{
"id": "doctex",
"aliases": [
"DocTeX",
"doctex"
],
"extensions": [
".dtx"
],
"configuration": "./syntax/syntax-doctex.json"
},
{
"id": "latex",
"aliases": [
"LaTeX",
"latex"
],
"extensions": [
".tex",
".ltx"
],
"configuration": "./syntax/syntax.json"
},
{
"id": "bibtex",
"aliases": [
"BibTeX",
"bibtex"
],
"extensions": [
".bib"
]
},
{
"id": "latex-expl3",
"aliases": [
"LaTeX-Expl3"
],
"configuration": "./syntax/syntax.json"
},
{
"id": "pdf",
"aliases": [
"Plain Text (PDF)",
"pdf"
],
"extensions": [
".pdf"
]
}
],
"grammars": [
{
"language": "tex",
"scopeName": "text.tex",
"path": "./syntax/TeX.tmLanguage.json"
},
{
"language": "doctex",
"scopeName": "text.tex.doctex",
"path": "./syntax/DocTeX.tmLanguage.json"
},
{
"language": "latex",
"scopeName": "text.tex.latex",
"path": "./syntax/LaTeX.tmLanguage.json",
"embeddedLanguages": {
"source.asymptote": "asymptote",
"source.cpp": "cpp",
"source.css": "css",
"source.dot": "dot",
"source.gnuplot": "gnuplot",
"text.html": "html",
"source.java": "java",
"source.js": "js",
"source.lua": "lua",
"source.python": "python",
"source.scala": "scala",
"text.xtml": "xtml",
"source.yaml": "yaml"
}
},
{
"language": "bibtex",
"scopeName": "text.bibtex",
"path": "./syntax/Bibtex.tmLanguage.json"
},
{
"language": "latex-expl3",
"scopeName": "text.tex.latex.expl3",
"path": "./syntax/LaTeX-Expl3.tmLanguage.json"
},
{
"scopeName": "markdown.latex.codeblock",
"path": "./syntax/latexblock.json",
"injectTo": [
"text.html.markdown"
],
"embeddedLanguages": {
"meta.embedded.block.latex": "latex"
}
}
],
"snippets": [
{
"language": "latex",
"path": "./snippets/latex.json"
}
],
"commands": [
{
"command": "latex-workshop.navigate-envpair",
"title": "Navigate to matching begin/end",
"category": "LaTeX Workshop"
},
{
"command": "latex-workshop.select-envname",
"title": "Select the current environment name",
"category": "LaTeX Workshop"
},
{
"command": "latex-workshop.multicursor-envname",
"title": "Add a multicursor to the current environment name",
"category": "LaTeX Workshop"
},
{
"command": "latex-workshop.wrap-env",
"title": "Surround selection with \\begin{}...\\end{}",
"category": "LaTeX Workshop"
},
{
"command": "latex-workshop.close-env",
"title": "Close current environment",
"category": "LaTeX Workshop"
},
{
"command": "latex-workshop.toggle-equation-envname",
"title": "Toggle between \\[...\\] and \\begin{}...\\end{}",
"category": "LaTeX Workshop"
},
{
"command": "latex-workshop.saveWithoutBuilding",
"title": "Save without Building",
"category": "LaTeX Workshop"
},
{
"command": "latex-workshop.build",
"title": "Build LaTeX project",
"category": "LaTeX Workshop"
},
{
"command": "latex-workshop.recipes",
"title": "Build with recipe",
"category": "LaTeX Workshop"
},
{
"command": "latex-workshop.view",
"title": "View LaTeX PDF file",
"category": "LaTeX Workshop",
"icon": {
"light": "icons/view-pdf-light.svg",
"dark": "icons/view-pdf-dark.svg"
}
},
{
"command": "latex-workshop.tab",
"title": "View LaTeX PDF file in VSCode tab",
"category": "LaTeX Workshop"
},
{
"command": "latex-workshop.refresh-viewer",
"title": "Refresh all LaTeX PDF viewers",
"category": "LaTeX Workshop"
},
{
"command": "latex-workshop.kill",
"title": "Kill LaTeX compiler process",
"category": "LaTeX Workshop"
},
{
"command": "latex-workshop.synctex",
"title": "SyncTeX from cursor",
"category": "LaTeX Workshop"
},
{
"command": "latex-workshop.clean",
"title": "Clean up auxiliary files",
"category": "LaTeX Workshop"
},
{
"command": "latex-workshop.citation",
"title": "Open citation browser",
"category": "LaTeX Workshop"
},
{
"command": "latex-workshop.addtexroot",
"title": "Insert %!TeX root magic comment",
"category": "LaTeX Workshop"
},
{
"command": "latex-workshop.wordcount",
"title": "Count words in LaTeX document",
"category": "LaTeX Workshop"
},
{
"command": "latex-workshop.log",
"title": "Show LaTeX Workshop messages",
"category": "LaTeX Workshop"
},
{
"command": "latex-workshop.actions",
"title": "LaTeX actions",
"category": "LaTeX Workshop"
},
{
"command": "latex-workshop-dev.parselog",
"title": "Parse current document as LaTeX logs",
"category": "LaTeX Workshop DevTools"
},
{
"command": "latex-workshop-dev.parsetex",
"title": "Parse current file as LaTeX AST",
"category": "LaTeX Workshop DevTools"
},
{
"command": "latex-workshop-dev.parsebib",
"title": "Parse current file as BibTeX AST",
"category": "LaTeX Workshop DevTools"
},
{
"command": "latex-workshop.texdoc",
"title": "Show package documentation",
"category": "LaTeX Workshop"
},
{
"command": "latex-workshop.showCompilationPanel",
"title": "Show LaTeX Compilation Info",
"category": "LaTeX Workshop"
},
{
"command": "latex-structure.toggle-follow-cursor",
"title": "Toggle follow cursor",
"category": "LaTeX Workshop"
},
{
"command": "latex-workshop.showSnippetPanel",
"title": "Show Snippet Panel",
"category": "LaTeX Workshop"
}
],
"keybindings": [
{
"key": "ctrl+l alt+b",
"mac": "cmd+l alt+b",
"command": "latex-workshop.build",
"when": "config.latex-workshop.bind.altKeymap.enabled"
},
{
"key": "ctrl+l alt+c",
"mac": "cmd+l alt+c",
"command": "latex-workshop.clean",
"when": "config.latex-workshop.bind.altKeymap.enabled"
},
{
"key": "ctrl+l alt+v",
"mac": "cmd+l alt+v",
"command": "latex-workshop.view",
"when": "config.latex-workshop.bind.altKeymap.enabled"
},
{
"key": "ctrl+l alt+j",
"mac": "cmd+l alt+j",
"command": "latex-workshop.synctex",
"when": "editorTextFocus && config.latex-workshop.bind.altKeymap.enabled"
},
{
"key": "ctrl+l alt+x",
"mac": "cmd+l alt+x",
"command": "workbench.view.extension.latex",
"when": "config.latex-workshop.bind.altKeymap.enabled"
},
{
"key": "ctrl+alt+b",
"mac": "cmd+alt+b",
"command": "latex-workshop.build",
"when": "!config.latex-workshop.bind.altKeymap.enabled"
},
{
"key": "ctrl+alt+c",
"mac": "cmd+alt+c",
"command": "latex-workshop.clean",
"when": "!config.latex-workshop.bind.altKeymap.enabled"
},
{
"key": "ctrl+alt+v",
"mac": "cmd+alt+v",
"command": "latex-workshop.view",
"when": "!config.latex-workshop.bind.altKeymap.enabled"
},
{
"key": "ctrl+alt+j",
"mac": "cmd+alt+j",
"command": "latex-workshop.synctex",
"when": "editorTextFocus && !config.latex-workshop.bind.altKeymap.enabled"
},
{
"key": "ctrl+alt+x",
"mac": "cmd+alt+x",
"command": "workbench.view.extension.latex",
"when": "!config.latex-workshop.bind.altKeymap.enabled"
},
{
"key": "ctrl+l ]",
"mac": "cmd+l ]",
"when": "editorTextFocus && !editorReadonly && editorLangId == 'latex' && config.latex-workshop.bind.altKeymap.enabled",
"command": "latex-workshop.increment-sectioning"
},
{
"key": "ctrl+l [",
"mac": "cmd+l [",
"when": "editorTextFocus && !editorReadonly && editorLangId == 'latex'&& config.latex-workshop.bind.altKeymap.enabled",
"command": "latex-workshop.decrement-sectioning"
},
{
"key": "ctrl+alt+]",
"mac": "cmd+alt+]",
"when": "editorTextFocus && !editorReadonly && editorLangId == 'latex' && !config.latex-workshop.bind.altKeymap.enabled",
"command": "latex-workshop.increment-sectioning"
},
{
"key": "ctrl+alt+[",
"mac": "cmd+alt+[",
"when": "editorTextFocus && !editorReadonly && editorLangId == 'latex'&& !config.latex-workshop.bind.altKeymap.enabled",
"command": "latex-workshop.decrement-sectioning"
},
{
"key": "ctrl+l ctrl+enter",
"mac": "cmd+l cmd+enter",
"when": "editorTextFocus && !editorReadonly && editorLangId == 'latex'",
"command": "latex-workshop.shortcut.item"
},
{
"key": "ctrl+l ctrl+b",
"mac": "cmd+l cmd+b",
"when": "editorTextFocus && !editorReadonly && editorLangId == 'latex'",
"command": "latex-workshop.shortcut.textbf"
},
{
"key": "ctrl+l ctrl+i",
"mac": "cmd+l cmd+i",
"when": "editorTextFocus && !editorReadonly && editorLangId == 'latex'",
"command": "latex-workshop.shortcut.textit"
},
{
"key": "ctrl+l ctrl+u",
"mac": "cmd+l cmd+u",
"when": "editorTextFocus && !editorReadonly && editorLangId == 'latex'",
"command": "latex-workshop.shortcut.underline"
},
{
"key": "ctrl+l ctrl+e",
"mac": "cmd+l cmd+e",
"when": "editorTextFocus && !editorReadonly && editorLangId == 'latex'",
"command": "latex-workshop.shortcut.emph"
},
{
"key": "ctrl+l ctrl+r",
"mac": "cmd+l cmd+r",
"when": "editorTextFocus && !editorReadonly && editorLangId == 'latex'",
"command": "latex-workshop.shortcut.textrm"
},
{
"key": "ctrl+l ctrl+t",
"mac": "cmd+l cmd+t",
"when": "editorTextFocus && !editorReadonly && editorLangId == 'latex'",
"command": "latex-workshop.shortcut.texttt"
},
{
"key": "ctrl+l ctrl+s",
"mac": "cmd+l cmd+s",
"when": "editorTextFocus && !editorReadonly && editorLangId == 'latex'",
"command": "latex-workshop.shortcut.textsl"
},
{
"key": "ctrl+l ctrl+c",
"mac": "cmd+l cmd+c",
"when": "editorTextFocus && !editorReadonly && editorLangId == 'latex'",
"command": "latex-workshop.shortcut.textsc"
},
{
"key": "ctrl+l ctrl+n",
"mac": "cmd+l cmd+n",
"when": "editorTextFocus && !editorReadonly && editorLangId == 'latex'",
"command": "latex-workshop.shortcut.textnormal"
},
{
"key": "ctrl+l ctrl+6",
"mac": "cmd+l cmd+6",
"when": "editorTextFocus && !editorReadonly && editorLangId == 'latex'",
"command": "latex-workshop.shortcut.textsuperscript"
},
{
"key": "ctrl+l ctrl+oem_minus",
"mac": "cmd+l cmd+oem_minus",
"when": "editorTextFocus && !editorReadonly && editorLangId == 'latex'",
"command": "latex-workshop.shortcut.textsubscript"
},
{
"key": "ctrl+m ctrl+b",
"mac": "cmd+m cmd+b",
"when": "editorTextFocus && !editorReadonly && editorLangId == 'latex'",
"command": "latex-workshop.shortcut.mathbf"
},
{
"key": "ctrl+m ctrl+i",
"mac": "cmd+m cmd+i",
"when": "editorTextFocus && !editorReadonly && editorLangId == 'latex'",
"command": "latex-workshop.shortcut.mathit"
},
{
"key": "ctrl+m ctrl+r",
"mac": "cmd+m cmd+r",
"when": "editorTextFocus && !editorReadonly && editorLangId == 'latex'",
"command": "latex-workshop.shortcut.mathrm"
},
{
"key": "ctrl+m ctrl+t",
"mac": "cmd+m cmd+t",
"when": "editorTextFocus && !editorReadonly && editorLangId == 'latex'",
"command": "latex-workshop.shortcut.mathtt"
},
{
"key": "ctrl+m ctrl+s",
"mac": "cmd+m cmd+s",
"when": "editorTextFocus && !editorReadonly && editorLangId == 'latex'",
"command": "latex-workshop.shortcut.mathsf"
},
{
"key": "ctrl+m ctrl+shift+b",
"mac": "cmd+m cmd+shift+b",
"when": "editorTextFocus && !editorReadonly && editorLangId == 'latex'",
"command": "latex-workshop.shortcut.mathbb"
},
{
"key": "ctrl+m ctrl+c",
"mac": "cmd+m cmd+c",
"when": "editorTextFocus && !editorReadonly && editorLangId == 'latex'",
"command": "latex-workshop.shortcut.mathcal"
},
{
"command": "expandLineSelection",
"key": "ctrl+l ctrl+l",
"mac": "cmd+l cmd+l",
"when": "textInputFocus && editorLangId == 'latex'"
},
{
"command": "editor.action.toggleTabFocusMode",
"key": "ctrl+l ctrl+m",
"mac": "cmd+l cmd+m",
"when": "textInputFocus && editorLangId == 'latex'"
},
{
"key": "ctrl+l ctrl+w",
"mac": "cmd+l cmd+w",
"when": "editorTextFocus && !editorReadonly && editorHasSelection && editorLangId == 'latex'",
"command": "latex-workshop.surround"
},
{
"command": "latex-workshop.onEnterKey",
"key": "enter",
"when": "editorTextFocus && !editorReadonly && editorLangId == 'latex' && !suggestWidgetVisible && vim.active && vim.mode == 'Insert'"
},
{
"command": "latex-workshop.onEnterKey",
"key": "enter",
"when": "editorTextFocus && !editorReadonly && editorLangId == 'latex' && !suggestWidgetVisible && !vim.active"
},
{
"command": "latex-workshop.onAltEnterKey",
"key": "alt+enter",
"when": "editorTextFocus && !editorReadonly && editorLangId == 'latex' && !suggestWidgetVisible"
}
],
"configurationDefaults": {
"[latex]": {
"editor.formatOnPaste": false,
"editor.formatOnSave": false,
"editor.suggestSelection": "recentlyUsedByPrefix"
}
},
"configuration": {
"type": "object",
"title": "LaTeX",
"properties": {
"latex-workshop.latex.recipes": {
"type": "array",
"default": [
{
"name": "latexmk 🔃",
"tools": [
"latexmk"
]
},
{
"name": "pdflatex ➞ bibtex ➞ pdflatex × 2",
"tools": [
"pdflatex",
"bibtex",
"pdflatex",
"pdflatex"
]
}
],
"markdownDescription": "Define LaTeX compiling recipes.\nEach recipe in the list is an object containing its name and the names of tools to be used sequentially, which are defined in `latex-workshop.latex.tools`.\nBy default, the first recipe is used to compile the project. For details, please visit https://github.com/James-Yu/LaTeX-Workshop/wiki/Compile#latex-recipe."
},
"latex-workshop.latex.recipe.default": {
"type": "string",
"enum": [
"first",
"lastUsed"
],
"enumDescriptions": [
"Use the first recipe",
"Use the last run recipe"
],
"default": "first",
"markdownDescription": "Define which recipe is used by `latex-workshop.build`. It also applies to auto build."
},
"latex-workshop.latex.tools": {
"type": "array",
"default": [
{
"name": "latexmk",
"command": "latexmk",
"args": [
"-synctex=1",
"-interaction=nonstopmode",
"-file-line-error",
"-pdf",
"-outdir=%OUTDIR%",
"%DOC%"
],
"env": {}
},
{
"name": "pdflatex",
"command": "pdflatex",
"args": [
"-synctex=1",
"-interaction=nonstopmode",
"-file-line-error",
"%DOC%"
],
"env": {}
},
{
"name": "bibtex",
"command": "bibtex",
"args": [
"%DOCFILE%"
],
"env": {}
}
],
"markdownDescription": "Define LaTeX compiling tools to be used in recipes.\nEach tool is labeled by its `name`. When invoked, `command` is spawned with arguments defined in `args` and environment variables defined in `env`. Typically no spaces should appear in each argument unless in paths.\nPlaceholders `%DOC%`, `%DOCFILE%`, `%DIR%`, `%TMPDIR%` and `%OUTDIR%` are available. For details, please visit https://github.com/James-Yu/LaTeX-Workshop/wiki/Compile#latex-recipe."
},
"latex-workshop.latex.magic.args": {
"type": "array",
"items": {
"type": "string"
},
"default": [
"-synctex=1",
"-interaction=nonstopmode",
"-file-line-error",
"%DOC%"
],
"markdownDescription": "Define the arguments to be input to magic command executable. This can be overridden by using \"% !TeX options\"."
},
"latex-workshop.latex.magic.bib.args": {
"type": "array",
"items": {
"type": "string"
},
"default": [
"%DOCFILE%"
],
"markdownDescription": "Define the arguments to be input to BIB magic command executable. This can be overridden by using \"% !BIB options\"."
},
"latex-workshop.latex.external.build.command": {
"type": "string",
"default": "",
"markdownDescription": "The external command to execute when calling latex-workshop.build.\nThis is useful when compiling relies on a Makefile or a bespoke script. When defined, it completely bypasses the recipes and root file detection mechanism."
},
"latex-workshop.latex.external.build.args": {
"type": "array",
"items": {
"type": "string"
},
"default": [],
"markdownDescription": "The arguments of `latex-workshop.latex.external.build.command` when calling latex-workshop.build."
},
"latex-workshop.latex.build.forceRecipeUsage": {
"type": "boolean",
"default": false,
"markdownDescription": "Force the use the recipe mechanism even if some magic comments are present."
},
"latex-workshop.latex.outDir": {
"type": "string",
"default": "%DIR%",
"markdownDescription": "The directory where the extension tries to find project files (e.g., PDF and SyncTeX files) are located.\nBoth relative and absolute paths are supported. Relative path start from the root file location, so beware if it is located in sub-directory. The path must not contain a trailing slash.\nThe LaTeX toolchain should output files to this path.\nPlaceholders `%DOC%`, `%DOCFILE%`, `%DIR%` and `%TMPDIR%` are available."
},
"latex-workshop.latex.texDirs": {
"type": "array",
"items": {
"type": "string"
},
"default": [],
"markdownDescription": "List of directories where to look for extra input `.tex` files. \nAbsolute paths are required. You may also need to set the environment variable `TEXINPUTS` properly for the LaTeX compiler to find the `.tex` files, see the `env` parameter of [recipes](https://github.com/James-Yu/LaTeX-Workshop/wiki/Compile#latex-recipes)."
},
"latex-workshop.latex.bibDirs": {
"type": "array",
"items": {
"type": "string"
},
"default": [],
"markdownDescription": "List of directories where to look for `.bib` files.\nAbsolute paths are required. This setting is only used by the intellisense feature, you may also need to set the environment variable `BIBINPUTS` properly for the LaTeX compiler to find the `.bib` files."
},
"latex-workshop.latex.search.rootFiles.include": {
"type": "array",
"items": {
"type": "string"
},
"default": [
"**/*.tex"
],
"markdownDescription": "Patterns of files to consider for the root detection mechanism.\nRelative paths are computed from the workspace folder. To detect the root file and the tex file tree, we parse all the `.tex` listed here.\nIf you want to specify all `.tex` files inside directory, say `foo`, and all its subdirectories recursively, you need to use `**/foo/**/*.tex`. If you only want to match `.tex` files at the top level of the workspace, use `*.tex`. For more details the [wiki](https://github.com/James-Yu/LaTeX-Workshop/wiki/Multi-File-Projects)."
},
"latex-workshop.latex.search.rootFiles.exclude": {
"type": "array",
"items": {
"type": "string"
},
"default": [],
"markdownDescription": "Patterns of files to exclude from the root detection mechanism.\nSee also `latex-workshop.latex.search.rootFiles.include`. For more details the [wiki](https://github.com/James-Yu/LaTeX-Workshop/wiki/Multi-File-Projects)."
},
"latex-workshop.latex.rootFile.useSubFile": {
"type": "boolean",
"default": true,
"markdownDescription": "When the `subfile` package is used, either the main file or any subfile containing `\\documentclass[main.tex]{subfile}` can be LaTeXing. When set to `true`, the extension uses the subfile as the rootFile for the `autobuild`, `clean` and `synctex` commands. Note that this setting does not affect the `build` and `view` command as they both ask the user's choice first."
},
"latex-workshop.latex.watch.files.ignore": {
"type": "array",
"items": {
"type": "string"
},
"default": [
"**/*.bbx",
"**/*.bbl",
"**/*.cbx",
"**/*.cfg",
"**/*.clo",
"**/*.cnf",
"**/*.def",
"**/*.dfu",
"**/*.enc",
"**/*.fd",
"**/*.fmt",
"**/*.lbx",
"**/*.map",
"**/*.mkii",
"**/*.pfb",
"**/*.tfm",
"**/*.vf",
"**/texmf-{dist,var}/**",
"/dev/null"
],
"markdownDescription": "Files to ignore from the watching mechanism used for triggering autobuild.\nThis property must be an array of globs pattern. The patterns are matched against the absolute file path. To ignore everything inside the `texmf` tree, `**/texmf/**` can be used."
},
"latex-workshop.latex.autoBuild.run": {
"type": "string",
"enum": [
"never",
"onFileChange"
],
"enumDescriptions": [
"Never run auto build",
"Auto build whenever a dependency file changes on disk"
],
"default": "onFileChange",
"markdownDescription": "When the extension shall auto build LaTeX project using the default (first) recipe.\n `onFileChange` builds the project upon detecting a file change in any of the dependencies, even modified by other applications."
},
"latex-workshop.latex.autoBuild.interval": {
"type": "integer",
"default": 1000,
"markdownDescription": "The minimal time interval between two consecutive auto builds in millisecond."
},
"latex-workshop.latex.autoBuild.cleanAndRetry.enabled": {
"type": "boolean",
"default": true,
"markdownDescription": "Delete LaTeX auxillary files when errors occur during build and retry.\nThis property defines whether LaTeX Workshop will try to clean and build the project once again after errors happen in the build toolchain."
},
"latex-workshop.latex.build.clearLog.everyRecipeStep.enabled": {
"type": "boolean",
"default": true,
"markdownDescription": "Clear the LaTeX Compiler logs before every step of a recipe.\nSet this property to false to keep the logs of all tools in a recipe."
},
"latex-workshop.latex.autoClean.run": {
"type": "string",
"enum": [
"never",
"onFailed",
"onBuilt"
],
"enumDescriptions": [
"Never clean the project",
"Clean compilation fails",
"Clean after build, be it successful or not"
],
"default": "never",
"markdownDescription": "When LaTeX auxillary files should be deleted.\nThe folder to be cleaned is defined in `latex-workshop.latex.outDir`.\n`onFailed` cleans the project when compilation fails. `onBuilt` cleans the project when compilation is terminated, whether successful or failed."
},
"latex-workshop.latex.clean.subfolder.enabled": {
"type": "boolean",
"default": false,
"markdownDescription": "Delete LaTeX auxillary files recursively in sub-folders of `latex-workshop.latex.outDir`."
},
"latex-workshop.latex.clean.fileTypes": {
"type": "array",
"items": {
"type": "string"
},
"default": [
"*.aux",
"*.bbl",
"*.blg",
"*.idx",
"*.ind",
"*.lof",
"*.lot",
"*.out",
"*.toc",
"*.acn",
"*.acr",
"*.alg",
"*.glg",
"*.glo",
"*.gls",
"*.ist",
"*.fls",
"*.log",
"*.fdb_latexmk"
],
"markdownDescription": "Files to clean.\nThis property must be an array of strings. File globs such as *.removeme, something?.aux can be used."
},
"latex-workshop.latex.option.maxPrintLine.enabled": {
"type": "boolean",
"default": true,
"markdownDescription": "Add `--max-print-line` option to LaTeX build commands. This flag tells some MikTeX compilers to produce non hard wrapped log messages. Non hard wrapped log messages are required for the _Problem_ Pane to properly display messages."
},
"latex-workshop.view.outline.sections": {
"type": "array",
"items": {
"type": "string"
},
"default": [
"part",
"chapter",
"section",
"subsection",
"subsubsection"
],
"markdownDescription": "The section names of LaTeX outline hierarchy. It is also used by the folding mechanism.\nThis property is an array of case-sensitive strings in the order of document structure hierarchy. For multiple tags in the same level, separate the tags with `|` as delimiters, e.g., `section|alternative`."
},
"latex-workshop.view.autoFocus.enabled": {
"type": "boolean",
"default": false,
"markdownDescription": "Auto focus the LaTeX view when switching from non-tex to tex files.\nThis will cause the view to appear consistently upon activating the extension."
},
"latex-workshop.view.pdf.viewer": {
"type": "string",
"default": "none",
"enum": [
"none",
"browser",
"tab",
"external"
],
"markdownDescription": "The default PDF viewer.",
"enumDescriptions": [
"Undetermined viewer. A viewer selector will pop up upon viewing PDF.",
"Open PDF with the default web browser.",
"Open PDF with the built-in tab viewer.",
"[Experimental] Open PDF with the external viewer set in \"View > Pdf > External: command\"."
]
},
"latex-workshop.view.pdf.tab.useNewGroup": {
"type": "boolean",
"default": true,
"markdownDescription": "When set to true, the viewer is opened in a new editor group, otherwise the current one is used."
},
"latex-workshop.view.pdf.ref.viewer": {
"type": "string",
"default": "auto",
"enum": [
"auto",
"tabOrBrowser",
"external"
],
"markdownDescription": "PDF viewer used for [View on PDF] link on \\ref."
},
"latex-workshop.viewer.pdf.internal.port": {
"type": "number",
"default": "0",
"markdownDescription": "Define the port to listen on for communicating with the internal viewer. The default value \"0\" means the port is chosen randomly by the application."
},
"latex-workshop.view.pdf.external.viewer.command": {
"type": "string",
"default": "",
"markdownDescription": "The command to execute when using external viewer.\nThis function is not officially supported."
},
"latex-workshop.view.pdf.external.viewer.args": {
"type": "array",
"items": {
"type": "string"
},
"default": [
"%PDF%"
],
"markdownDescription": "The arguments for `latex-workshop.view.pdf.external.viewer.command` when using external viewer.\nThis function is not officially supported. %PDF% is the placeholder for the absolute path to the generated PDF file."
},
"latex-workshop.view.pdf.external.synctex.command": {
"type": "string",
"default": "",
"markdownDescription": "The command to execute when forward synctex to external viewer.\nThis function is not officially supported."
},
"latex-workshop.view.pdf.external.synctex.args": {
"type": "array",
"items": {
"type": "string"
},
"default": [
"%LINE%",
"%PDF%",
"%TEX%"
],
"markdownDescription": "The arguments for `latex-workshop.view.pdf.external.synctex.args` when forward synctex to external viewer.\n%LINE% is the line number, %PDF% is the placeholder for the absolute path to the generated PDF file, and %TEX% is the source LaTeX file path with `.tex` extension from which syncTeX is fired."
},
"latex-workshop.view.pdf.zoom": {
"type": "string",
"default": "auto",
"markdownDescription": "The default zoom level of the PDF viewer.\nThis default value will be passed to the viewer upon opening. Possible values are `auto`, `page-actual`, `page-fit`, `page-width`, and one-based scale values (e.g., 0.5 for 50%, 2.0 for 200%)."
},
"latex-workshop.view.pdf.trim": {
"type": "number",
"default": 0,
"enum": [
0,
1,
2,
3
],
"markdownDescription": "The default trim mode of the PDF viewer.",
"enumDescriptions": [
"No page trimming",
"Trim 5% at margin",
"Trim 10% at margin",
"Trim 15% at margin"
]
},
"latex-workshop.view.pdf.scrollMode": {
"type": "number",
"default": 0,
"markdownDescription": "The default scroll mode of the PDF viewer.\nThis default value will be passed to the viewer upon opening. Possible values are `0` (vertical), `1`(horizontal) and `2` (wrapped)."
},
"latex-workshop.view.pdf.spreadMode": {
"type": "number",
"default": 0,
"markdownDescription": "The default spread mode of the PDF viewer.\nThis default value will be passed to the viewer upon opening. Possible values are `0` (none), `1` (odd) and `2` (even)."
},
"latex-workshop.view.pdf.hand": {
"type": "boolean",
"default": false,
"markdownDescription": "Define if the hand tool is enabled by default in the PDF viewer."
},
"latex-workshop.view.pdf.invert": {
"type": "number",
"default": 0,
"markdownDescription": "Define the CSS invert filter level of the PDF viewer.\nThis config can invert the color of PDF. Possible values are from 0 to 1."
},
"latex-workshop.synctex.path": {
"type": "string",
"default": "synctex",
"markdownDescription": "Define the location of SyncTeX executive file.\nAdditional arguments, e.g., synctex modes and position of click, will be appended to this command."
},
"latex-workshop.synctex.afterBuild.enabled": {
"type": "boolean",
"default": false,
"markdownDescription": "Execute forward synctex at cursor position after compiling LaTeX project."
},
"latex-workshop.synctex.synctexjs.enabled": {
"type": "boolean",
"default": true,
"markdownDescription": "Enable using a builtin synctex function. The command set in latex-workshop.synctex.path will not be used."
},
"latex-workshop.chktex.enabled": {
"type": "boolean",
"default": false,
"markdownDescription": "Enable linting LaTeX with ChkTeX.\nCheck `latex-workshop.chktex.run` to control when the linting is executed if this config is set to `true`."
},
"latex-workshop.chktex.run": {
"type": "string",
"enum": [
"onSave",
"onType"
],
"default": "onSave",
"markdownDescription": "When LaTeX should be linted by ChkTeX.\nIf set to `onSave`, the whole LaTeX project will be linted upon saving.\nIf set to `onType`, the active document will be linted when input is stopped for a period of time defined in `latex-workshop.chktex.delay`, besides the behavior of `onSave`."
},
"latex-workshop.chktex.path": {
"type": "string",
"default": "chktex",
"markdownDescription": "Define the location of ChkTeX executive file.\nThis command will be joint with `latex-workshop.chktex.args.*` and required arguments to form a complete command of ChkTeX."
},
"latex-workshop.chktex.args.active": {
"type": "array",
"items": {
"type": "string"
},
"default": [
"-wall",
"-n22",
"-n30",
"-e16",
"-q"
],
"markdownDescription": "Linter arguments to check LaTeX syntax of the current file state in real time with ChkTeX.\nArguments must be in separate strings in the array. Additional arguments, i.e., `-I0 -f%f:%l:%c:%d:%k:%n:%m\\n` will be appended when constructing the command. Current file contents will be piped to the command through stdin."
},
"latex-workshop.chktex.args.root": {