README.md

Tue, 12 May 2020 18:17:39 -0500

author
Tuomo Valkonen <tuomov@iki.fi>
date
Tue, 12 May 2020 18:17:39 -0500
changeset 4
acf39baa1c7d
parent 3
8fbba60a1df4
child 5
993903fd4434
permissions
-rw-r--r--

More README improvements

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

mercurial