add a section about customizing syntax highlighting

leafgarland · Aug 15, 2018 · aaf0d3e · aaf0d3e
1 parent f35c66b
commit aaf0d3e
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -109,4 +109,14 @@ autocmd QuickFixCmdPost [^l]* nested cwindow
 autocmd QuickFixCmdPost    l* nested lwindow
 ```
 
+Syntax highlighting
+-------------------
+
+Syntax highlighting for TypeScript can be customized by following variables.
+
+- `g:typescript_ignore_typescriptdoc`: When this variable is defined, doccomments will not be
+  highlighted.
+- `g:typescript_ignore_browserwords`: When this variable is set to `1`, browser API names such as
+  `window` or `document` will not be highlighted. (default to `0`)
+
 ![Obligatory screenshot](https://raw.github.com/leafgarland/typescript-vim/master/vimshot01.png)