README.md

Tue, 12 May 2020 09:29:36 -0500

author
Tuomo Valkonen <tuomov@iki.fi>
date
Tue, 12 May 2020 09:29:36 -0500
changeset 3
8fbba60a1df4
parent 1
6c4986d204ac
child 4
acf39baa1c7d
permissions
-rw-r--r--

More README detail

0
aa9fc390ce91 Initial version.
Tuomo Valkonen <tuomov@iki.fi>
parents:
diff changeset
1 # latex-syntax
aa9fc390ce91 Initial version.
Tuomo Valkonen <tuomov@iki.fi>
parents:
diff changeset
2
1
6c4986d204ac README improvements
Tuomo Valkonen <tuomov@iki.fi>
parents: 0
diff changeset
3 This package provides LaTeX syntax highlighting for VSCode. It is intended
3
8fbba60a1df4 More README detail
Tuomo Valkonen <tuomov@iki.fi>
parents: 1
diff changeset
4 to be used as together with [texlab][] (as a language intelligence and
8fbba60a1df4 More README detail
Tuomo Valkonen <tuomov@iki.fi>
parents: 1
diff changeset
5 build system interface) to provide richer syntax highlighting. The grammar
8fbba60a1df4 More README detail
Tuomo Valkonen <tuomov@iki.fi>
parents: 1
diff changeset
6 is derived from LaTeX-Workshop, but has improvements including
0
aa9fc390ce91 Initial version.
Tuomo Valkonen <tuomov@iki.fi>
parents:
diff changeset
7
aa9fc390ce91 Initial version.
Tuomo Valkonen <tuomov@iki.fi>
parents:
diff changeset
8 a) Highlighting of `todonotes` (see below).
aa9fc390ce91 Initial version.
Tuomo Valkonen <tuomov@iki.fi>
parents:
diff changeset
9
aa9fc390ce91 Initial version.
Tuomo Valkonen <tuomov@iki.fi>
parents:
diff changeset
10 b) Footnote highlighting.
aa9fc390ce91 Initial version.
Tuomo Valkonen <tuomov@iki.fi>
parents:
diff changeset
11
aa9fc390ce91 Initial version.
Tuomo Valkonen <tuomov@iki.fi>
parents:
diff changeset
12 c) Highlighting of `comment` environments as comment blocks.
aa9fc390ce91 Initial version.
Tuomo Valkonen <tuomov@iki.fi>
parents:
diff changeset
13
aa9fc390ce91 Initial version.
Tuomo Valkonen <tuomov@iki.fi>
parents:
diff changeset
14 ### How to enable
aa9fc390ce91 Initial version.
Tuomo Valkonen <tuomov@iki.fi>
parents:
diff changeset
15
aa9fc390ce91 Initial version.
Tuomo Valkonen <tuomov@iki.fi>
parents:
diff changeset
16 This package does not override the standard “LaTeX” grammar. It provides the
aa9fc390ce91 Initial version.
Tuomo Valkonen <tuomov@iki.fi>
parents:
diff changeset
17 “LaTeX+” grammar. Please select that as the default grammar for `.tex` files.
aa9fc390ce91 Initial version.
Tuomo Valkonen <tuomov@iki.fi>
parents:
diff changeset
18
aa9fc390ce91 Initial version.
Tuomo Valkonen <tuomov@iki.fi>
parents:
diff changeset
19 ### Regarding `todonotes` and `footnote` support
aa9fc390ce91 Initial version.
Tuomo Valkonen <tuomov@iki.fi>
parents:
diff changeset
20
aa9fc390ce91 Initial version.
Tuomo Valkonen <tuomov@iki.fi>
parents:
diff changeset
21 To enable syntax highlighting for `\todo` and `\footnote`, add the following
1
6c4986d204ac README improvements
Tuomo Valkonen <tuomov@iki.fi>
parents: 0
diff changeset
22 (with possibly customised colours) to your user `settings.json`
6c4986d204ac README improvements
Tuomo Valkonen <tuomov@iki.fi>
parents: 0
diff changeset
23 (Cmd+Shift+P, “Open Settings (JSON)”):
0
aa9fc390ce91 Initial version.
Tuomo Valkonen <tuomov@iki.fi>
parents:
diff changeset
24
aa9fc390ce91 Initial version.
Tuomo Valkonen <tuomov@iki.fi>
parents:
diff changeset
25 ```json
1
6c4986d204ac README improvements
Tuomo Valkonen <tuomov@iki.fi>
parents: 0
diff changeset
26 "editor.tokenColorCustomizations": {
6c4986d204ac README improvements
Tuomo Valkonen <tuomov@iki.fi>
parents: 0
diff changeset
27 "textMateRules": [
6c4986d204ac README improvements
Tuomo Valkonen <tuomov@iki.fi>
parents: 0
diff changeset
28 {
6c4986d204ac README improvements
Tuomo Valkonen <tuomov@iki.fi>
parents: 0
diff changeset
29 "scope": "entity.name.todo.latex",
6c4986d204ac README improvements
Tuomo Valkonen <tuomov@iki.fi>
parents: 0
diff changeset
30 "settings": {
6c4986d204ac README improvements
Tuomo Valkonen <tuomov@iki.fi>
parents: 0
diff changeset
31 "foreground": "#d17000",
6c4986d204ac README improvements
Tuomo Valkonen <tuomov@iki.fi>
parents: 0
diff changeset
32 "fontStyle": "italic",
6c4986d204ac README improvements
Tuomo Valkonen <tuomov@iki.fi>
parents: 0
diff changeset
33 }
6c4986d204ac README improvements
Tuomo Valkonen <tuomov@iki.fi>
parents: 0
diff changeset
34 },
6c4986d204ac README improvements
Tuomo Valkonen <tuomov@iki.fi>
parents: 0
diff changeset
35 {
6c4986d204ac README improvements
Tuomo Valkonen <tuomov@iki.fi>
parents: 0
diff changeset
36 "scope": "support.function.todo.latex",
6c4986d204ac README improvements
Tuomo Valkonen <tuomov@iki.fi>
parents: 0
diff changeset
37 "settings": {
6c4986d204ac README improvements
Tuomo Valkonen <tuomov@iki.fi>
parents: 0
diff changeset
38 "foreground": "#d17000",
6c4986d204ac README improvements
Tuomo Valkonen <tuomov@iki.fi>
parents: 0
diff changeset
39 "fontStyle": "italic",
0
aa9fc390ce91 Initial version.
Tuomo Valkonen <tuomov@iki.fi>
parents:
diff changeset
40 }
1
6c4986d204ac README improvements
Tuomo Valkonen <tuomov@iki.fi>
parents: 0
diff changeset
41 },
6c4986d204ac README improvements
Tuomo Valkonen <tuomov@iki.fi>
parents: 0
diff changeset
42 {
6c4986d204ac README improvements
Tuomo Valkonen <tuomov@iki.fi>
parents: 0
diff changeset
43 "scope": "entity.name.footnote.latex",
6c4986d204ac README improvements
Tuomo Valkonen <tuomov@iki.fi>
parents: 0
diff changeset
44 "settings": {
6c4986d204ac README improvements
Tuomo Valkonen <tuomov@iki.fi>
parents: 0
diff changeset
45 "foreground": "#e28000",
6c4986d204ac README improvements
Tuomo Valkonen <tuomov@iki.fi>
parents: 0
diff changeset
46 "fontStyle": "italic",
6c4986d204ac README improvements
Tuomo Valkonen <tuomov@iki.fi>
parents: 0
diff changeset
47 }
6c4986d204ac README improvements
Tuomo Valkonen <tuomov@iki.fi>
parents: 0
diff changeset
48 },
6c4986d204ac README improvements
Tuomo Valkonen <tuomov@iki.fi>
parents: 0
diff changeset
49 {
6c4986d204ac README improvements
Tuomo Valkonen <tuomov@iki.fi>
parents: 0
diff changeset
50 "scope": "support.function.footnote.latex",
6c4986d204ac README improvements
Tuomo Valkonen <tuomov@iki.fi>
parents: 0
diff changeset
51 "settings": {
6c4986d204ac README improvements
Tuomo Valkonen <tuomov@iki.fi>
parents: 0
diff changeset
52 "foreground": "#e28000",
6c4986d204ac README improvements
Tuomo Valkonen <tuomov@iki.fi>
parents: 0
diff changeset
53 "fontStyle": "italic",
6c4986d204ac README improvements
Tuomo Valkonen <tuomov@iki.fi>
parents: 0
diff changeset
54 }
6c4986d204ac README improvements
Tuomo Valkonen <tuomov@iki.fi>
parents: 0
diff changeset
55 }
6c4986d204ac README improvements
Tuomo Valkonen <tuomov@iki.fi>
parents: 0
diff changeset
56 ],
6c4986d204ac README improvements
Tuomo Valkonen <tuomov@iki.fi>
parents: 0
diff changeset
57 },
0
aa9fc390ce91 Initial version.
Tuomo Valkonen <tuomov@iki.fi>
parents:
diff changeset
58 ```
aa9fc390ce91 Initial version.
Tuomo Valkonen <tuomov@iki.fi>
parents:
diff changeset
59
aa9fc390ce91 Initial version.
Tuomo Valkonen <tuomov@iki.fi>
parents:
diff changeset
60 [texlab]: https://marketplace.visualstudio.com/items?itemName=efoerster.texlab

mercurial