X-Git-Url: https://code.delx.au/gnu-emacs-elpa/blobdiff_plain/cbffe2a5feafd41375dac392959a8a25a6f309c3..a1649922afd8053f8ce149e9862e6211607ece06:/README.md diff --git a/README.md b/README.md index 787403ece..21f1eb5cf 100644 --- a/README.md +++ b/README.md @@ -13,13 +13,13 @@ By default, comments and strings are still highlighted syntactically. ## Features +- Light and dark customizable color schemes. - JavaScript support: - Script, function and block scopes (and even `catch` block scopes). - - Very fast for files under 1000 lines. + - Node.js "file-level" scope detection. - Emacs Lisp support: - `defun`, `lambda`, `let`, `let*`, `cond`, `condition-case`, `defadvice`, `dolist`, `quote`, `backquote` and backquote splicing. - - Instantaneous lazy coloring, 8000 lines-per-second full coloring. - Works in `eval-expression` too. ## Installation @@ -27,8 +27,8 @@ By default, comments and strings are still highlighted syntactically. Requires Emacs 24.3+. JavaScript language support requires [js2-mode](https://github.com/mooz/js2-mode). -`M-x package-install RET context-coloring RET` and add the following to your -init file: +To install, run the command `M-x package-install RET context-coloring RET`, and +then add the following to your init file: ```lisp ;; JavaScript: @@ -39,30 +39,17 @@ init file: (add-hook 'emacs-lisp-mode-hook #'context-coloring-mode) ;; eval-expression: -(add-hook 'minibuffer-setup-hook #'context-coloring-mode) +(add-hook 'eval-expression-minibuffer-setup-hook #'context-coloring-mode) ; 24.4+ +(add-hook 'minibuffer-setup-hook #'context-coloring-mode) ; 24.3 ``` ## Color Schemes -There is *no default color scheme*. Define the colors according to your liking -by setting the appropriate custom faces and the maximum face: +The [Zenburn](https://github.com/bbatsov/zenburn-emacs) theme, featured in the +screenshot above, now supports context coloring. -```lisp -(custom-theme-set-faces - 'zenburn - '(context-coloring-level-0-face ((t :foreground "#dcdccc"))) - '(context-coloring-level-1-face ((t :foreground "#93e0e3"))) - '(context-coloring-level-2-face ((t :foreground "#bfebbf"))) - '(context-coloring-level-3-face ((t :foreground "#f0dfaf"))) - '(context-coloring-level-4-face ((t :foreground "#dfaf8f"))) - '(context-coloring-level-5-face ((t :foreground "#cc9393"))) - '(context-coloring-level-6-face ((t :foreground "#dc8cc3"))) - '(context-coloring-level-7-face ((t :foreground "#94bff3"))) - '(context-coloring-level-8-face ((t :foreground "#9fc59f"))) - '(context-coloring-level-9-face ((t :foreground "#d0bf8f"))) - '(context-coloring-level-10-face ((t :foreground "#dca3a3")))) -(setq context-coloring-maximum-face 10) -``` +You can define your own colors by customizing faces like +`context-coloring-level-N-face`, where N is a number starting from 0. [See here](https://gist.github.com/jacksonrayhamilton/6b89ca3b85182c490816) for some color schemes for popular custom themes. @@ -73,7 +60,7 @@ some color schemes for popular custom themes. comments using `font-lock`. - `context-coloring-syntactic-strings` (default: `t`): If non-nil, also color strings using `font-lock`. -- `context-coloring-default-delay` (default: `0.25`): Default delay between a - buffer update and colorization. - `context-coloring-javascript-block-scopes` (default: `nil`): If non-nil, also color block scopes in the scope hierarchy in JavaScript. +- `context-coloring-javascript-detect-top-level-scope` (default: `t`): If + non-nil, detect when to use file-level scope.