Skip to content

Commit

Permalink
Use nested markdown grammar for highlighting docstrings
Browse files Browse the repository at this point in the history
This uses the "inline" version of the markdown grammar.

https://github.com/MDeiml/tree-sitter-markdown

see issue #18
  • Loading branch information
dannyfreeman committed Sep 9, 2023
1 parent 881756c commit f0eca67
Show file tree
Hide file tree
Showing 3 changed files with 253 additions and 194 deletions.
9 changes: 6 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,11 +106,14 @@ git clone https://github.com/clojure-emacs/clojure-ts-mode.git

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

### Install libtree-sitter-clojure shared library
### Install tree-sitter grammars

The compile tree-sitter clojure shared library must be available to Emacs.
Additionally, the tree-sitter [markdown_inline](https://github.com/MDeiml/tree-sitter-markdown) shared library will also be used for docstrings if available.

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

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

Expand Down
Loading

0 comments on commit f0eca67

Please sign in to comment.