Skip to content

Commit f0eca67

Browse files
committed
Use nested markdown grammar for highlighting docstrings
This uses the "inline" version of the markdown grammar. https://github.com/MDeiml/tree-sitter-markdown see issue #18
1 parent 881756c commit f0eca67

File tree

3 files changed

+253
-194
lines changed

3 files changed

+253
-194
lines changed

README.md

+6-3
Original file line numberDiff line numberDiff line change
@@ -106,11 +106,14 @@ git clone https://github.com/clojure-emacs/clojure-ts-mode.git
106106

107107
Once installed, evaluate clojure-ts-mode.el and you should be ready to go.
108108

109-
### Install libtree-sitter-clojure shared library
109+
### Install tree-sitter grammars
110+
111+
The compile tree-sitter clojure shared library must be available to Emacs.
112+
Additionally, the tree-sitter [markdown_inline](https://github.com/MDeiml/tree-sitter-markdown) shared library will also be used for docstrings if available.
110113

111-
The tree-sitter clojure shared library must be available to Emacs.
112114
If you have `git` and a C compiler (`cc`) available on your system's `PATH`, **then these steps should not be necessary**.
113-
clojure-ts-mode will install the grammar when you first open a Clojure file.
115+
clojure-ts-mode will install the grammars when you first open a Clojure file and
116+
`clojure-ts-ensure-grammars` is set to `t` (the default).
114117

115118
If clojure-ts-mode fails to automatically install the grammar, you have the option to install it manually.
116119

0 commit comments

Comments
 (0)