Skip to content

Commit c5e575e

Browse files
committed
[Docs] Add more documentation about the clojure-ts-mode support
1 parent e6ad3ae commit c5e575e

File tree

2 files changed

+15
-12
lines changed

2 files changed

+15
-12
lines changed

README.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,13 +13,13 @@ CIDER is the **C**lojure(Script) **I**nteractive **D**evelopment **E**nvironment
1313
that **R**ocks!
1414

1515
CIDER extends Emacs with support for [interactive
16-
programming](https://docs.cider.mx/cider/usage/interactive_programming.html)
17-
in Clojure. The features are centered around `cider-mode`, an Emacs
18-
minor-mode that complements [clojure-mode][]. While `clojure-mode`
19-
supports editing Clojure source files, `cider-mode` adds support for
20-
interacting with a running Clojure process for compilation, code
21-
completion, debugging, definition and documentation lookup, running
22-
tests and so on.
16+
programming](https://docs.cider.mx/cider/usage/interactive_programming.html) in
17+
Clojure. The features are centered around `cider-mode`, an Emacs minor-mode that
18+
complements [clojure-mode][] and [clojure-ts-mode][]. While `clojure-mode` and
19+
`clojure-ts-mode` support editing Clojure source files, `cider-mode` adds
20+
support for interacting with a running Clojure process for compilation, code
21+
completion, debugging, definition and documentation lookup, running tests and so
22+
on.
2323

2424
----------
2525
[![OpenCollective](https://opencollective.com/cider/backers/badge.svg)](#open-collective-backers)
@@ -270,4 +270,5 @@ Copyright © 2012-2024 Bozhidar Batsov, Artur Malabarba, Tim King, Phil Hagelber
270270
[Sly]: https://github.com/joaotavora/sly
271271
[Geiser]: https://github.com/jaor/geiser
272272
[clojure-mode]: https://github.com/clojure-emacs/clojure-mode
273+
[clojure-ts-mode]: https://github.com/clojure-emacs/clojure-ts-mode
273274
[inf-clojure]: https://github.com/clojure-emacs/inf-clojure

doc/modules/ROOT/pages/caveats.adoc

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -84,16 +84,18 @@ the xref:basics/middleware_setup.adoc#setting-up-a-standalone-repl[standalone RE
8484
* Adjust the value of `cider-injected-nrepl-version` to the same nREPL version as the
8585
one that's bundled with Leiningen.
8686

87-
== Clojure-ts-mode integration
87+
== clojure-ts-mode integration
8888

89-
Cider has basic support for working with
89+
NOTE: `clojure-ts-mode` support was introduced in CIDER 1.14.
90+
91+
CIDER has basic support for working with
9092
https://github.com/clojure-emacs/clojure-ts-mode[clojure-ts-mode] buffers, but it still depends on
9193
https://github.com/clojure-emacs/clojure-mode[clojure-mode] for certain functionality, like
92-
extracting information about clojure code out of the buffer. We hope to make clojure-ts-mode capable
93-
of providing cider with all the functionality it needs to interact with clojure buffers, but that
94+
extracting information about Clojure code out of the buffer. We hope to make `clojure-ts-mode` capable
95+
of providing CIDER with all the functionality it needs to interact with Clojure buffers, but that
9496
will take some time.
9597

9698
Additionally, some features like
9799
xref:config/indentation.adoc#dynamic-indentation[`cider-dynamic-indentation`]
98100
and xref:config/syntax_highlighting.adoc#dynamic-syntax-highlighting[`cider-font-lock-dynamically`]
99-
are not supported by clojure-ts-mode.
101+
are not supported by `clojure-ts-mode`.

0 commit comments

Comments
 (0)