Skip to content

Commit 91b2431

Browse files
committed
Small README tweaks
1 parent 09f7da6 commit 91b2431

File tree

1 file changed

+22
-14
lines changed

1 file changed

+22
-14
lines changed

README.md

Lines changed: 22 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,9 @@ them. Enter `clojure-ts-mode`, which makes use of Tree-sitter to provide:
2323

2424
- fast, accurate and more granular font-locking
2525
- fast indentation
26-
- common Emacs functionality like structured navigation, `imenu` (an outline of a source buffer), current form inference (used internally by various Emacs modes and utilities), etc
26+
- common Emacs functionality like structured navigation, `imenu` (an outline of
27+
a source buffer), current form inference (used internally by various Emacs
28+
modes and utilities), etc
2729

2830
Working with Tree-sitter is significantly easier than the legacy Emacs APIs for font-locking and
2931
indentation, which makes it easier to contribute to `clojure-ts-mode`, and to improve it in general.
@@ -156,13 +158,16 @@ Most configuration changes will require reverting any active `clojure-ts-mode` b
156158

157159
### Remapping of `clojure-mode` buffers
158160

159-
By default, `clojure-ts-mode` assumes command over all buffers and file extensions previously associated with `clojure-mode` (and derived major modes like `clojurescript-mode`). To disable this remapping, set
161+
By default, `clojure-ts-mode` assumes command over all buffers and file
162+
extensions previously associated with `clojure-mode` (and derived major modes
163+
like `clojurescript-mode`). To disable this remapping, set
160164

161165
``` emacs-lisp
162166
(setopt clojure-ts-auto-remap nil)
163167
```
164168

165-
You can also use the commands `clojure-ts-activate` / `clojure-ts-deactivate` to interactively change this behavior.
169+
You can also use the commands `clojure-ts-activate` / `clojure-ts-deactivate` to
170+
interactively change this behavior.
166171

167172
### Indentation
168173

@@ -297,27 +302,28 @@ highlighted like regular Clojure code.
297302
298303
### Highlight markdown syntax in docstrings
299304

300-
By default markdown syntax is highlighted in the docstrings using
301-
`markdown-inline` grammar. To disable this feature set
305+
By default Markdown syntax is highlighted in the docstrings using
306+
`markdown-inline` grammar. To disable this feature use:
302307

303308
``` emacs-lisp
304309
(setopt clojure-ts-use-markdown-inline nil)
305310
```
306311

307-
Example of syntax highlighting:
312+
Example of Markdown syntax highlighting:
308313

309314
<img width="512" src="/screenshots/markdown-syntax-dark-theme.png">
310315

311-
### Highlight regex syntax
316+
### Highlight regular expression syntax
312317

313-
By default syntax inside regex literals is highlighted using [regex](https://github.com/tree-sitter/tree-sitter-regex) grammar. To
314-
disable this feature set
318+
By default syntax inside regex literals is highlighted using
319+
[regex](https://github.com/tree-sitter/tree-sitter-regex) grammar. To disable
320+
this feature use:
315321

316322
```emacs-lisp
317323
(setopt clojure-ts-use-regex-parser nil)
318324
```
319325

320-
Example of syntax highlighting:
326+
Example of regex syntax highlighting:
321327

322328
<img width="512" src="/screenshots/regex-syntax-dark-theme.png">
323329

@@ -368,9 +374,10 @@ following customization:
368374

369375
## Migrating to clojure-ts-mode
370376

371-
If you are migrating to `clojure-ts-mode` note that `clojure-mode` is still required for cider and clj-refactor packages to work properly.
377+
If you are migrating to `clojure-ts-mode` note that `clojure-mode` is still
378+
required for cider and clj-refactor packages to work properly.
372379

373-
After installing the package do the following.
380+
After installing the package do the following:
374381

375382
- Check the value of `clojure-mode-hook` and copy all relevant hooks to `clojure-ts-mode-hook`.
376383

@@ -381,7 +388,8 @@ After installing the package do the following.
381388
(add-hook 'clojure-ts-mode-hook #'clj-refactor-mode)
382389
```
383390

384-
- Update `.dir-locals.el` in all of your Clojure projects to activate directory local variables in `clojure-ts-mode`.
391+
- Update `.dir-locals.el` in all of your Clojure projects to activate directory
392+
local variables in `clojure-ts-mode`.
385393

386394
``` emacs-lisp
387395
((clojure-mode
@@ -411,7 +419,7 @@ and `clojure-mode` (this is very helpful when dealing with `derived-mode-p` chec
411419

412420
### What `clojure-mode` features are currently missing?
413421

414-
As of version 0.2.x, the most obvious missing feature are the various
422+
As of version 0.4.x, the most obvious missing feature are the various
415423
refactoring commands in `clojure-mode`.
416424

417425
### Does `clojure-ts-mode` work with CIDER?

0 commit comments

Comments
 (0)